Jamf Pro Customer API v0.2
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Jamf Pro Customer API
Base URL = http://example.com/JSSResource
Terms of service Email: Developer RelationsWeb: Developer Relations License: Jamf Pro Customer API License
accounts
findAccounts
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/accounts \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/accounts HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/accounts',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/accounts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/accounts', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/accounts', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/accounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /accounts
Finds all accounts
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<users>
<user>
<id>0</id>
<name>string</name>
</user>
</users>
<groups>
<group>
<id>0</id>
<name>string</name>
</group>
</groups>
findGroupsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/accounts/groupid/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/accounts/groupid/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/accounts/groupid/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/accounts/groupid/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/accounts/groupid/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/accounts/groupid/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/accounts/groupid/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /accounts/groupid/{id}
Finds groups by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Group Name</name>
updateGroupById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/accounts/groupid/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/accounts/groupid/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/accounts/groupid/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/accounts/groupid/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/accounts/groupid/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/accounts/groupid/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/accounts/groupid/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /accounts/groupid/{id}
Updates an existing group by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createGroupById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/accounts/groupid/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/accounts/groupid/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/accounts/groupid/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "Group Name"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/accounts/groupid/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/accounts/groupid/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/accounts/groupid/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/accounts/groupid/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /accounts/groupid/{id}
Creates a new group by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | group | true | Group name |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Group Name</name>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteGroupById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/accounts/groupid/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/accounts/groupid/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/accounts/groupid/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/accounts/groupid/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/accounts/groupid/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/accounts/groupid/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/accounts/groupid/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /accounts/groupid/{id}
Deletes a group by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findGroupsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/accounts/groupname/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/accounts/groupname/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/accounts/groupname/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/accounts/groupname/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/accounts/groupname/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/accounts/groupname/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/accounts/groupname/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /accounts/groupname/{name}
Finds groups by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Group Name</name>
updateGroupByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/accounts/groupname/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/accounts/groupname/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/accounts/groupname/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/accounts/groupname/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/accounts/groupname/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/accounts/groupname/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/accounts/groupname/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /accounts/groupname/{name}
Updates an existing group by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | integer | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteGroupByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/accounts/groupname/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/accounts/groupname/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/accounts/groupname/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/accounts/groupname/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/accounts/groupname/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/accounts/groupname/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/accounts/groupname/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /accounts/groupname/{name}
Deletes a group by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | integer | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findAccountsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/accounts/userid/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/accounts/userid/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/accounts/userid/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/accounts/userid/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/accounts/userid/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/accounts/userid/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/accounts/userid/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /accounts/userid/{id}
Finds accounts by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
updateAccountById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/accounts/userid/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/accounts/userid/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/accounts/userid/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/accounts/userid/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/accounts/userid/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/accounts/userid/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/accounts/userid/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /accounts/userid/{id}
Updates an existing account by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createAccountById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/accounts/userid/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/accounts/userid/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/accounts/userid/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/accounts/userid/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/accounts/userid/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/accounts/userid/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/accounts/userid/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /accounts/userid/{id}
Creates a new account by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | account | true | Account name |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteAccountById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/accounts/userid/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/accounts/userid/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/accounts/userid/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/accounts/userid/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/accounts/userid/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/accounts/userid/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/accounts/userid/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /accounts/userid/{id}
Deletes an account by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findAccountsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/accounts/username/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/accounts/username/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/accounts/username/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/accounts/username/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/accounts/username/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/accounts/username/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/accounts/username/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /accounts/username/{name}
Finds accounts by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
updateAccountByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/accounts/username/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/accounts/username/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/accounts/username/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/accounts/username/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/accounts/username/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/accounts/username/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/accounts/username/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /accounts/username/{name}
Updates an existing account by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteAccountByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/accounts/username/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/accounts/username/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/accounts/username/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/accounts/username/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/accounts/username/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/accounts/username/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/accounts/username/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /accounts/username/{name}
Deletes an account by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
advancedcomputersearches
findAdvancedComputerSearches
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/advancedcomputersearches \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/advancedcomputersearches HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedcomputersearches',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedcomputersearches',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/advancedcomputersearches', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/advancedcomputersearches', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedcomputersearches");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /advancedcomputersearches
Finds all advanced computer searches
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<advanced_computer_search>
<id>0</id>
<name>string</name>
</advanced_computer_search>
findAdvancedComputerSearchesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/advancedcomputersearches/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/advancedcomputersearches/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedcomputersearches/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedcomputersearches/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/advancedcomputersearches/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/advancedcomputersearches/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedcomputersearches/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /advancedcomputersearches/id/{id}
Finds computer searches by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Advanced Search Name</name>
<view_as>string</view_as>
<sort_1>string</sort_1>
<sort_2>string</sort_2>
<sort_3>string</sort_3>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<display_fields>
<display_field>
<name>string</name>
</display_field>
</display_fields>
<computers>
<computer>
<id>0</id>
<name>string</name>
<udid>string</udid>
<Computer_Name>string</Computer_Name>
</computer>
</computers>
<site>
<id>0</id>
<name>string</name>
</site>
updateAdvancedComputerSearchById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/advancedcomputersearches/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/advancedcomputersearches/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedcomputersearches/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedcomputersearches/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/advancedcomputersearches/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/advancedcomputersearches/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedcomputersearches/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /advancedcomputersearches/id/{id}
Updates an existing advanced computer search by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createAdvancedComputerSearchgById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/advancedcomputersearches/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/advancedcomputersearches/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedcomputersearches/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "Advanced Search Name",
"view_as": "string",
"sort_1": "string",
"sort_2": "string",
"sort_3": "string",
"criteria": {
"criterion": {
"name": "string",
"priority": 0,
"and_or": "and",
"search_type": "string",
"value": "string",
"opening_paren": true,
"closing_paren": true
}
},
"display_fields": {
"display_field": {
"name": "string"
}
},
"computers": {
"computer": {
"id": 0,
"name": "string",
"udid": "string",
"Computer_Name": "string"
}
},
"site": {
"id": 0,
"name": "string"
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedcomputersearches/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/advancedcomputersearches/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/advancedcomputersearches/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedcomputersearches/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /advancedcomputersearches/id/{id}
Creates a new advanced computer search
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID to filter by |
| body | body | advanced_computer_search | true | Name of object |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Advanced Search Name</name>
<view_as>string</view_as>
<sort_1>string</sort_1>
<sort_2>string</sort_2>
<sort_3>string</sort_3>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<display_fields>
<display_field>
<name>string</name>
</display_field>
</display_fields>
<computers>
<computer>
<id>0</id>
<name>string</name>
<udid>string</udid>
<Computer_Name>string</Computer_Name>
</computer>
</computers>
<site>
<id>0</id>
<name>string</name>
</site>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteAdvancedComputerSearchById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/advancedcomputersearches/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/advancedcomputersearches/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedcomputersearches/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedcomputersearches/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/advancedcomputersearches/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/advancedcomputersearches/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedcomputersearches/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /advancedcomputersearches/id/{id}
Deletes a computer search by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findAdvancedComputerSearchesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/advancedcomputersearches/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/advancedcomputersearches/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedcomputersearches/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedcomputersearches/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/advancedcomputersearches/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/advancedcomputersearches/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedcomputersearches/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /advancedcomputersearches/name/{name}
Finds advanced computer searches by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Advanced Search Name</name>
<view_as>string</view_as>
<sort_1>string</sort_1>
<sort_2>string</sort_2>
<sort_3>string</sort_3>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<display_fields>
<display_field>
<name>string</name>
</display_field>
</display_fields>
<computers>
<computer>
<id>0</id>
<name>string</name>
<udid>string</udid>
<Computer_Name>string</Computer_Name>
</computer>
</computers>
<site>
<id>0</id>
<name>string</name>
</site>
updateAdvancedComputerSearchByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/advancedcomputersearches/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/advancedcomputersearches/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedcomputersearches/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedcomputersearches/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/advancedcomputersearches/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/advancedcomputersearches/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedcomputersearches/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /advancedcomputersearches/name/{name}
Updates an existing advanced computer search by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteAdvancedComputerSearchByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/advancedcomputersearches/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/advancedcomputersearches/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedcomputersearches/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedcomputersearches/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/advancedcomputersearches/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/advancedcomputersearches/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedcomputersearches/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /advancedcomputersearches/name/{name}
Deletes a computer search by Name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findAdvancedMobileDeviceSearches
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/advancedmobiledevicesearches \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/advancedmobiledevicesearches HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedmobiledevicesearches',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedmobiledevicesearches',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/advancedmobiledevicesearches', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/advancedmobiledevicesearches', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedmobiledevicesearches");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /advancedmobiledevicesearches
Finds all advanced mobile device searches
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<advanced_mobile_device_search>
<id>0</id>
<name>Advanced Search Name</name>
<view_as>string</view_as>
<sort_1>string</sort_1>
<sort_2>string</sort_2>
<sort_3>string</sort_3>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<display_fields>
<display_field>
<name>string</name>
</display_field>
</display_fields>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
<udid>string</udid>
<Display_Name>string</Display_Name>
</mobile_device>
</mobile_devices>
<site>
<id>0</id>
<name>string</name>
</site>
</advanced_mobile_device_search>
findAdvancedMobileDeviceSearchesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/advancedmobiledevicesearches/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/advancedmobiledevicesearches/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /advancedmobiledevicesearches/id/{id}
Finds mobile device searches by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Advanced Search Name</name>
<view_as>string</view_as>
<sort_1>string</sort_1>
<sort_2>string</sort_2>
<sort_3>string</sort_3>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<display_fields>
<display_field>
<name>string</name>
</display_field>
</display_fields>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
<udid>string</udid>
<Display_Name>string</Display_Name>
</mobile_device>
</mobile_devices>
<site>
<id>0</id>
<name>string</name>
</site>
updateAdvancedMobileDeviceSearchById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/advancedmobiledevicesearches/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/advancedmobiledevicesearches/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /advancedmobiledevicesearches/id/{id}
Updates an existing advanced mobile device search by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createAdvancedMobileDeviceSearchById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/advancedmobiledevicesearches/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/advancedmobiledevicesearches/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "Advanced Search Name",
"view_as": "string",
"sort_1": "string",
"sort_2": "string",
"sort_3": "string",
"criteria": {
"criterion": {
"name": "string",
"priority": 0,
"and_or": "and",
"search_type": "string",
"value": "string",
"opening_paren": true,
"closing_paren": true
}
},
"display_fields": {
"display_field": {
"name": "string"
}
},
"mobile_devices": {
"mobile_device": {
"id": 0,
"name": "string",
"udid": "string",
"Display_Name": "string"
}
},
"site": {
"id": 0,
"name": "string"
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /advancedmobiledevicesearches/id/{id}
Creates a new advanced mobile device search
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | advanced_mobile_device_search | true | Name of advanced mobile device search |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Advanced Search Name</name>
<view_as>string</view_as>
<sort_1>string</sort_1>
<sort_2>string</sort_2>
<sort_3>string</sort_3>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<display_fields>
<display_field>
<name>string</name>
</display_field>
</display_fields>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
<udid>string</udid>
<Display_Name>string</Display_Name>
</mobile_device>
</mobile_devices>
<site>
<id>0</id>
<name>string</name>
</site>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteAdvancedMobileDeviceSearchById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/advancedmobiledevicesearches/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/advancedmobiledevicesearches/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedmobiledevicesearches/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /advancedmobiledevicesearches/id/{id}
Deletes a mobile device search by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDeviceSearchesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/advancedmobiledevicesearches/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/advancedmobiledevicesearches/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedmobiledevicesearches/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedmobiledevicesearches/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/advancedmobiledevicesearches/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/advancedmobiledevicesearches/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedmobiledevicesearches/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /advancedmobiledevicesearches/name/{name}
Finds advanced mobile device searches by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Advanced Search Name</name>
<view_as>string</view_as>
<sort_1>string</sort_1>
<sort_2>string</sort_2>
<sort_3>string</sort_3>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<display_fields>
<display_field>
<name>string</name>
</display_field>
</display_fields>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
<udid>string</udid>
<Display_Name>string</Display_Name>
</mobile_device>
</mobile_devices>
<site>
<id>0</id>
<name>string</name>
</site>
updateAdvancedMobileDeviceSearchByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/advancedmobiledevicesearches/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/advancedmobiledevicesearches/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedmobiledevicesearches/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedmobiledevicesearches/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/advancedmobiledevicesearches/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/advancedmobiledevicesearches/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedmobiledevicesearches/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /advancedmobiledevicesearches/name/{name}
Updates an existing advanced mobile device search by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Nameto filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteAdvancedMobileDeviceSearchByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/advancedmobiledevicesearches/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/advancedmobiledevicesearches/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedmobiledevicesearches/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedmobiledevicesearches/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/advancedmobiledevicesearches/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/advancedmobiledevicesearches/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedmobiledevicesearches/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /advancedmobiledevicesearches/name/{name}
Deletes a mobile device search by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findAdvancedUserSearches
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/advancedusersearches \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/advancedusersearches HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedusersearches',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedusersearches',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/advancedusersearches', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/advancedusersearches', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedusersearches");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /advancedusersearches
Finds all advanced user searches
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<advanced_user_search>
<id>0</id>
<name>Advanced Search Name</name>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<users>
<user>
<id>0</id>
<name>string</name>
<Username>string</Username>
</user>
</users>
<display_fields>
<display_field>
<name>string</name>
</display_field>
</display_fields>
<site>
<id>0</id>
<name>string</name>
</site>
</advanced_user_search>
findAdvancedUserSearchesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/advancedusersearches/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/advancedusersearches/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedusersearches/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedusersearches/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/advancedusersearches/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/advancedusersearches/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedusersearches/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /advancedusersearches/id/{id}
Finds user searches by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Advanced Search Name</name>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<users>
<user>
<id>0</id>
<name>string</name>
<Username>string</Username>
</user>
</users>
<display_fields>
<display_field>
<name>string</name>
</display_field>
</display_fields>
<site>
<id>0</id>
<name>string</name>
</site>
updateAdvancedUserSearchById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/advancedusersearches/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/advancedusersearches/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedusersearches/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedusersearches/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/advancedusersearches/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/advancedusersearches/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedusersearches/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /advancedusersearches/id/{id}
Updates an existing advanced user search by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
createAdvancedUserSearchgById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/advancedusersearches/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/advancedusersearches/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedusersearches/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "Advanced Search Name",
"criteria": {
"criterion": {
"name": "string",
"priority": 0,
"and_or": "and",
"search_type": "string",
"value": "string",
"opening_paren": true,
"closing_paren": true
}
},
"users": {
"user": {
"id": 0,
"name": "string",
"Username": "string"
}
},
"display_fields": {
"display_field": {
"name": "string"
}
},
"site": {
"id": 0,
"name": "string"
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedusersearches/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/advancedusersearches/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/advancedusersearches/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedusersearches/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /advancedusersearches/id/{id}
Creates a new advanced user search by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | advanced_user_search | true | Name of advanced user search |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Advanced Search Name</name>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<users>
<user>
<id>0</id>
<name>string</name>
<Username>string</Username>
</user>
</users>
<display_fields>
<display_field>
<name>string</name>
</display_field>
</display_fields>
<site>
<id>0</id>
<name>string</name>
</site>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteAdvancedUserSearchById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/advancedusersearches/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/advancedusersearches/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedusersearches/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedusersearches/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/advancedusersearches/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/advancedusersearches/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedusersearches/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /advancedusersearches/id/{id}
Deletes a user search by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findUserSearchesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/advancedusersearches/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/advancedusersearches/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedusersearches/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedusersearches/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/advancedusersearches/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/advancedusersearches/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedusersearches/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /advancedusersearches/name/{name}
Finds user searches by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Advanced Search Name</name>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<users>
<user>
<id>0</id>
<name>string</name>
<Username>string</Username>
</user>
</users>
<display_fields>
<display_field>
<name>string</name>
</display_field>
</display_fields>
<site>
<id>0</id>
<name>string</name>
</site>
updateAdvancedUserSearchByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/advancedusersearches/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/advancedusersearches/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedusersearches/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedusersearches/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/advancedusersearches/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/advancedusersearches/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedusersearches/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /advancedusersearches/name/{name}
Updates an existing advanced user search by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
deleteAdvancedUserSearchByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/advancedusersearches/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/advancedusersearches/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/advancedusersearches/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/advancedusersearches/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/advancedusersearches/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/advancedusersearches/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/advancedusersearches/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /advancedusersearches/name/{name}
Deletes a user search by Name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findAllowedFileExtension
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/allowedfileextensions \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/allowedfileextensions HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/allowedfileextensions',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/allowedfileextensions',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/allowedfileextensions', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/allowedfileextensions', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/allowedfileextensions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /allowedfileextensions
Finds the allowed file extensions
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findAllowedFileExtensionById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/allowedfileextensions/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/allowedfileextensions/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/allowedfileextensions/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/allowedfileextensions/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/allowedfileextensions/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/allowedfileextensions/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/allowedfileextensions/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /allowedfileextensions/id/{id}
Finds an allowed file extension value by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | Database ID of the extension |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<extension>jpg</extension>
createAllowedFileExtensionById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/allowedfileextensions/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/allowedfileextensions/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/allowedfileextensions/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"extension": "jpg"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/allowedfileextensions/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/allowedfileextensions/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/allowedfileextensions/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/allowedfileextensions/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /allowedfileextensions/id/{id}
Creates a new allowed file extension value by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | Database ID of the extension |
| body | body | allowed_file_extension | true | Name of advanced user search |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<extension>jpg</extension>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteAllowedFileExtensionById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/allowedfileextensions/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/allowedfileextensions/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/allowedfileextensions/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/allowedfileextensions/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/allowedfileextensions/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/allowedfileextensions/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/allowedfileextensions/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /allowedfileextensions/id/{id}
Deletes an allowed file extension value by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | Database ID of the extension |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findAllowedFileExtensionByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/allowedfileextensions/extension/{extension} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/allowedfileextensions/extension/{extension} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/allowedfileextensions/extension/{extension}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/allowedfileextensions/extension/{extension}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/allowedfileextensions/extension/{extension}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/allowedfileextensions/extension/{extension}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/allowedfileextensions/extension/{extension}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /allowedfileextensions/extension/{extension}
Finds an allowed file extension value by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| extension | path | string | true | String value of extension |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<extension>jpg</extension>
findBuildings
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/buildings \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/buildings HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/buildings',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/buildings',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/buildings', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/buildings', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/buildings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /buildings
Finds all buildings
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findBuildingsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/buildings/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/buildings/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/buildings/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/buildings/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/buildings/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/buildings/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/buildings/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /buildings/id/{id}
Finds buildings by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Building Name</name>
updateBuildingById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/buildings/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/buildings/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/buildings/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/buildings/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/buildings/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/buildings/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/buildings/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /buildings/id/{id}
Updates an existing building by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createBuildingById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/buildings/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/buildings/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/buildings/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "Building Name"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/buildings/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/buildings/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/buildings/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/buildings/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /buildings/id/{id}
Creates a new building
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | building | true | Name of building |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Building Name</name>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteBuildingById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/buildings/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/buildings/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/buildings/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/buildings/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/buildings/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/buildings/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/buildings/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /buildings/id/{id}
Deletes a building by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findBuildingsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/buildings/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/buildings/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/buildings/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/buildings/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/buildings/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/buildings/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/buildings/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /buildings/name/{name}
Finds buildings by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Building Name</name>
updateBuildingByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/buildings/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/buildings/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/buildings/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/buildings/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/buildings/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/buildings/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/buildings/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /buildings/name/{name}
Updates an existing building by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteBuildingByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/buildings/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/buildings/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/buildings/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/buildings/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/buildings/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/buildings/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/buildings/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /buildings/name/{name}
Deletes a building by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findBYOProfiles
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/byoprofiles \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/byoprofiles HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/byoprofiles',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/byoprofiles',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/byoprofiles', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/byoprofiles', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/byoprofiles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /byoprofiles
Finds all personal device profiles
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findBYOProfilesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/byoprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/byoprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/byoprofiles/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/byoprofiles/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/byoprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/byoprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/byoprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /byoprofiles/id/{id}
Finds personal device profile by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<site>
<id>0</id>
<name>string</name>
</site>
<enabled>true</enabled>
<description>string</description>
</general>
<enrollment_messaging>string</enrollment_messaging>
updateBYOProfilesById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/byoprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/byoprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/byoprofiles/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/byoprofiles/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/byoprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/byoprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/byoprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /byoprofiles/id/{id}
Updates a personal device profile by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createBYOProfilesById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/byoprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/byoprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/byoprofiles/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"id": 0,
"name": "string",
"site": {
"id": 0,
"name": "string"
},
"enabled": true,
"description": "string"
},
"enrollment_messaging": "string"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/byoprofiles/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/byoprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/byoprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/byoprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /byoprofiles/id/{id}
Creates a personal device profile by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | byoprofile | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<site>
<id>0</id>
<name>string</name>
</site>
<enabled>true</enabled>
<description>string</description>
</general>
<enrollment_messaging>string</enrollment_messaging>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteBYOProfilesById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/byoprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/byoprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/byoprofiles/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/byoprofiles/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/byoprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/byoprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/byoprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /byoprofiles/id/{id}
Deletes a personal device profile by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findBYOProfilesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/byoprofiles/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/byoprofiles/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/byoprofiles/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/byoprofiles/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/byoprofiles/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/byoprofiles/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/byoprofiles/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /byoprofiles/name/{name}
Finds a personal device profile by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<site>
<id>0</id>
<name>string</name>
</site>
<enabled>true</enabled>
<description>string</description>
</general>
<enrollment_messaging>string</enrollment_messaging>
updateBYOProfilesByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/byoprofiles/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/byoprofiles/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/byoprofiles/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/byoprofiles/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/byoprofiles/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/byoprofiles/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/byoprofiles/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /byoprofiles/name/{name}
Updates a personal device profile by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteBYOProfilesByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/byoprofiles/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/byoprofiles/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/byoprofiles/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/byoprofiles/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/byoprofiles/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/byoprofiles/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/byoprofiles/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /byoprofiles/name/{name}
Deletes a personal device profile by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findCategories
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/categories \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/categories HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/categories',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/categories',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/categories', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/categories', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/categories");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /categories
Finds all categories
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findCategoriesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/categories/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/categories/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/categories/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/categories/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/categories/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/categories/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/categories/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /categories/id/{id}
Finds categories by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
updateCategoryById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/categories/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/categories/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/categories/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/categories/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/categories/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/categories/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/categories/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /categories/id/{id}
Updates an existing category by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
createCategoryById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/categories/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/categories/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/categories/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "Category name",
"priority": 9
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/categories/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/categories/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/categories/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/categories/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /categories/id/{id}
Creates a new category by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | category | true | Name of category |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteCategoryById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/categories/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/categories/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/categories/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/categories/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/categories/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/categories/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/categories/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /categories/id/{id}
Deletes a category by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findCategoriesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/categories/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/categories/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/categories/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/categories/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/categories/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/categories/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/categories/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /categories/name/{name}
Finds categories by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
updateCategoryByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/categories/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/categories/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/categories/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/categories/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/categories/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/categories/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/categories/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /categories/name/{name}
Updates an existing category by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
deleteCategoryByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/categories/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/categories/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/categories/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/categories/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/categories/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/categories/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/categories/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /categories/name/{name}
Deletes a category by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | integer | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findClasses
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/classes \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/classes HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/classes',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/classes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/classes', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/classes', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/classes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /classes
Finds all classes
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findClassesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/classes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/classes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/classes/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/classes/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/classes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/classes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/classes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /classes/id/{id}
Finds classes by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<source>string</source>
<name>Class Name</name>
<description>string</description>
<site>
<id>0</id>
<name>string</name>
</site>
<mobile_device_group>
<id>0</id>
<name>string</name>
</mobile_device_group>
<students>
<student>string</student>
</students>
<teachers>
<teacher>string</teacher>
</teachers>
<teacher_ids>
<id>0</id>
</teacher_ids>
<student_group_ids>
<id>0</id>
</student_group_ids>
<teacher_group_ids>
<id>0</id>
</teacher_group_ids>
<mobile_devices>
<mobile_device>
<name>string</name>
<udid>string</udid>
<wifi_mac_address>string</wifi_mac_address>
</mobile_device>
</mobile_devices>
updateClassById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/classes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/classes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/classes/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/classes/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/classes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/classes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/classes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /classes/id/{id}
Updates an existing class by ID
The mobile device list is not used by this operation, the mobile device group is used instead.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
createClassById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/classes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/classes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/classes/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "Category name",
"priority": 9
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/classes/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/classes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/classes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/classes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /classes/id/{id}
Creates a new class by ID
The mobile device list is not used by this operation, the mobile device group is used instead.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | category | true | Class name |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteClassById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/classes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/classes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/classes/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/classes/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/classes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/classes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/classes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /classes/id/{id}
Deletes a class by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findClassesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/classes/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/classes/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/classes/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/classes/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/classes/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/classes/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/classes/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /classes/name/{name}
Finds classes by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<source>string</source>
<name>Class Name</name>
<description>string</description>
<site>
<id>0</id>
<name>string</name>
</site>
<mobile_device_group>
<id>0</id>
<name>string</name>
</mobile_device_group>
<students>
<student>string</student>
</students>
<teachers>
<teacher>string</teacher>
</teachers>
<teacher_ids>
<id>0</id>
</teacher_ids>
<student_group_ids>
<id>0</id>
</student_group_ids>
<teacher_group_ids>
<id>0</id>
</teacher_group_ids>
<mobile_devices>
<mobile_device>
<name>string</name>
<udid>string</udid>
<wifi_mac_address>string</wifi_mac_address>
</mobile_device>
</mobile_devices>
updateClassByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/classes/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/classes/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/classes/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/classes/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/classes/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/classes/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/classes/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /classes/name/{name}
Updates an existing class by name
The mobile device list is not used by this operation, the mobile device group is used instead.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
deleteClassByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/classes/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/classes/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/classes/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/classes/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/classes/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/classes/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/classes/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /classes/name/{name}
Deletes a class by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
commandFlush
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/commandflush \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/commandflush HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/commandflush',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"status": "string",
"mobile_devices": {
"mobile_device": {
"id": 0
}
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/commandflush',
{
method: 'DELETE',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/commandflush', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/commandflush', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/commandflush");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /commandflush
Flushes commands based on information specified in an XML file
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | commandflush | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<status>string</status>
<mobile_devices>
<mobile_device>
<id>0</id>
</mobile_device>
</mobile_devices>
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
createCommandFlushWithIdAndStatus
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/commandflush/{idtype}/id/{id}/status/{status} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/commandflush/{idtype}/id/{id}/status/{status} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/commandflush/{idtype}/id/{id}/status/{status}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/commandflush/{idtype}/id/{id}/status/{status}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/commandflush/{idtype}/id/{id}/status/{status}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/commandflush/{idtype}/id/{id}/status/{status}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/commandflush/{idtype}/id/{id}/status/{status}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /commandflush/{idtype}/id/{id}/status/{status}
Flushes commands for devices
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| idtype | path | string | true | Type of device to be flushed |
| id | path | integer | true | ID of device to be flushed |
| status | path | string | true | Command status to be flushed |
Enumerated Values
| Parameter | Value |
|---|---|
| idtype | computers |
| idtype | computergroups |
| idtype | mobiledevices |
| idtype | mobiledevicegroups |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputerApplicationsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerapplications/application/{application} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerapplications/application/{application} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerapplications/application/{application}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerapplications/application/{application}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerapplications/application/{application}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerapplications/application/{application}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerapplications/application/{application}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerapplications/application/{application}
Finds computer applications by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| application | path | string | true | Application name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputerApplicationsByNameInventory
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerapplications/application/{application}/inventory/{inventory} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerapplications/application/{application}/inventory/{inventory} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerapplications/application/{application}/inventory/{inventory}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerapplications/application/{application}/inventory/{inventory}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerapplications/application/{application}/inventory/{inventory}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerapplications/application/{application}/inventory/{inventory}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerapplications/application/{application}/inventory/{inventory}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerapplications/application/{application}/inventory/{inventory}
Finds computer applications by name with additional display fields
Valid values for inventory are comma separated Display Fields for computers. Display Fields with spaces must be percent encoded (e.g. /computerapplications/application/Safari.app/inventory/Operating%20System,Last%20Check-in)
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| application | path | string | true | Application name to filter by |
| inventory | path | string | true | Inventory options |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputerApplicationByNameAndVersion
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerapplications/application/{application}/version/{version} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerapplications/application/{application}/version/{version} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerapplications/application/{application}/version/{version}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerapplications/application/{application}/version/{version}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerapplications/application/{application}/version/{version}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerapplications/application/{application}/version/{version}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerapplications/application/{application}/version/{version}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerapplications/application/{application}/version/{version}
Finds computer applications by name and version
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| application | path | string | true | Application name to filter by |
| version | path | string | true | Version to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputerApplicationsByNameAndVersionAndInventory
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerapplications/application/{application}/version/{version}/inventory/{inventory} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerapplications/application/{application}/version/{version}/inventory/{inventory} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerapplications/application/{application}/version/{version}/inventory/{inventory}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerapplications/application/{application}/version/{version}/inventory/{inventory}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerapplications/application/{application}/version/{version}/inventory/{inventory}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerapplications/application/{application}/version/{version}/inventory/{inventory}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerapplications/application/{application}/version/{version}/inventory/{inventory}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerapplications/application/{application}/version/{version}/inventory/{inventory}
Finds computer applications by name and version
Generates additional inventory data for the devices matching the search criteria
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| application | path | string | true | Application name to filter by |
| version | path | string | true | Version to filter by |
| inventory | path | string | true | Inventory options |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputerApplicationUsageById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerapplicationusage/id/{id}/{start_date}_{end_date} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerapplicationusage/id/{id}/{start_date}_{end_date} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerapplicationusage/id/{id}/{start_date}_{end_date}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerapplicationusage/id/{id}/{start_date}_{end_date}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerapplicationusage/id/{id}/{start_date}_{end_date}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerapplicationusage/id/{id}/{start_date}_{end_date}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerapplicationusage/id/{id}/{start_date}_{end_date}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerapplicationusage/id/{id}/{start_date}_{end_date}
Finds computer application usage by computer ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | ID value to filter by |
| start_date | path | string | true | Start date (e.g. yyyy-mm-dd) |
| end_date | path | string | true | End date (e.g. yyyy-mm-dd) |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputerApplicationUsageByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerapplicationusage/name/{name}/{start_date}_{end_date} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerapplicationusage/name/{name}/{start_date}_{end_date} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerapplicationusage/name/{name}/{start_date}_{end_date}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerapplicationusage/name/{name}/{start_date}_{end_date}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerapplicationusage/name/{name}/{start_date}_{end_date}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerapplicationusage/name/{name}/{start_date}_{end_date}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerapplicationusage/name/{name}/{start_date}_{end_date}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerapplicationusage/name/{name}/{start_date}_{end_date}
Finds computer application usage by computer name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
| start_date | path | string | true | Start date (e.g. yyyy-mm-dd) |
| end_date | path | string | true | End date (e.g. yyyy-mm-dd) |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputerApplicationUsageByUDID
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerapplicationusage/udid/{udid}/{start_date}_{end_date} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerapplicationusage/udid/{udid}/{start_date}_{end_date} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerapplicationusage/udid/{udid}/{start_date}_{end_date}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerapplicationusage/udid/{udid}/{start_date}_{end_date}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerapplicationusage/udid/{udid}/{start_date}_{end_date}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerapplicationusage/udid/{udid}/{start_date}_{end_date}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerapplicationusage/udid/{udid}/{start_date}_{end_date}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerapplicationusage/udid/{udid}/{start_date}_{end_date}
Finds computer application usage by computer UDID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| udid | path | string | true | UDID to filter by |
| start_date | path | string | true | Start date (e.g. yyyy-mm-dd) |
| end_date | path | string | true | End date (e.g. yyyy-mm-dd) |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputerApplicationUsageBySerial
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerapplicationusage/serialnumber/{serialnumber}/{start_date}_{end_date} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerapplicationusage/serialnumber/{serialnumber}/{start_date}_{end_date} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerapplicationusage/serialnumber/{serialnumber}/{start_date}_{end_date}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerapplicationusage/serialnumber/{serialnumber}/{start_date}_{end_date}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerapplicationusage/serialnumber/{serialnumber}/{start_date}_{end_date}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerapplicationusage/serialnumber/{serialnumber}/{start_date}_{end_date}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerapplicationusage/serialnumber/{serialnumber}/{start_date}_{end_date}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerapplicationusage/serialnumber/{serialnumber}/{start_date}_{end_date}
Finds computer application usage by computer serial number
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| serialnumber | path | string | true | Serial number to filter by |
| start_date | path | string | true | Start date (e.g. yyyy-mm-dd) |
| end_date | path | string | true | End date (e.g. yyyy-mm-dd) |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputerApplicationUsageByMacAddress
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerapplicationusage/macaddress/{macaddress}/{start_date}_{end_date} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerapplicationusage/macaddress/{macaddress}/{start_date}_{end_date} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerapplicationusage/macaddress/{macaddress}/{start_date}_{end_date}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerapplicationusage/macaddress/{macaddress}/{start_date}_{end_date}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerapplicationusage/macaddress/{macaddress}/{start_date}_{end_date}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerapplicationusage/macaddress/{macaddress}/{start_date}_{end_date}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerapplicationusage/macaddress/{macaddress}/{start_date}_{end_date}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerapplicationusage/macaddress/{macaddress}/{start_date}_{end_date}
Finds computer application usage by computer MAC address
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| macaddress | path | string | true | MAC address to filter by |
| start_date | path | string | true | Start date (e.g. yyyy-mm-dd) |
| end_date | path | string | true | End date (e.g. yyyy-mm-dd) |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputerCheckin
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computercheckin \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computercheckin HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computercheckin',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computercheckin',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computercheckin', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computercheckin', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computercheckin");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computercheckin
Finds the JSS computer checkin information
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<check_in_frequency>60</check_in_frequency>
<create_startup_script>true</create_startup_script>
<log_startup_event>true</log_startup_event>
<check_for_policies_at_startup>true</check_for_policies_at_startup>
<apply_computer_level_managed_preferences>true</apply_computer_level_managed_preferences>
<ensure_ssh_is_enabled>true</ensure_ssh_is_enabled>
<create_login_logout_hooks>true</create_login_logout_hooks>
<log_username>true</log_username>
<check_for_policies_at_login_logout>true</check_for_policies_at_login_logout>
<apply_user_level_managed_preferences>true</apply_user_level_managed_preferences>
<hide_restore_partition>true</hide_restore_partition>
<perform_login_actions_in_background>true</perform_login_actions_in_background>
<display_status_to_user>true</display_status_to_user>
updateComputerCheckin
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/computercheckin \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/computercheckin HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computercheckin',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computercheckin',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/computercheckin', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/computercheckin', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computercheckin");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /computercheckin
Updates the JSS computer checkin information
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
findComputerCommands
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computercommands \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computercommands HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computercommands',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computercommands',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computercommands', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computercommands', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computercommands");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computercommands
Finds all computer commands
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<computer_command>
<id>0</id>
<command>EraseDevice</command>
</computer_command>
createComputerCommandByCommand
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/computercommands/command/{command} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/computercommands/command/{command} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computercommands/command/{command}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"command": "DeviceLock"
},
"computers": {
"computer": {
"id": 0
}
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computercommands/command/{command}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/computercommands/command/{command}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/computercommands/command/{command}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computercommands/command/{command}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /computercommands/command/{command}
Creates a new computer command using command name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| command | path | string | true | No description |
| body | body | computer_command | true | Command name |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<command>DeviceLock</command>
</general>
<computers>
<computer>
<id>0</id>
</computer>
</computers>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
findComputerCommandsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computercommands/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computercommands/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computercommands/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computercommands/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computercommands/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computercommands/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computercommands/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computercommands/id/{id}
Finds a computer command by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<command>DeviceLock</command>
</general>
<computers>
<computer>
<id>0</id>
</computer>
</computers>
findComputerCommandsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computercommands/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computercommands/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computercommands/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computercommands/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computercommands/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computercommands/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computercommands/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computercommands/name/{name}
Finds all computer commands by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<command>DeviceLock</command>
</general>
<computers>
<computer>
<id>0</id>
</computer>
</computers>
findComputerCommandsByUuid
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computercommands/uuid/{uuid} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computercommands/uuid/{uuid} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computercommands/uuid/{uuid}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computercommands/uuid/{uuid}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computercommands/uuid/{uuid}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computercommands/uuid/{uuid}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computercommands/uuid/{uuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computercommands/uuid/{uuid}
Finds a computer command by UUID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| uuid | path | string | true | No description |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<command>DeviceLock</command>
</general>
<computers>
<computer>
<id>0</id>
</computer>
</computers>
findComputerConfigurations
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerconfigurations \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerconfigurations HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerconfigurations',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerconfigurations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerconfigurations', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerconfigurations', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerconfigurations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerconfigurations
Finds all computer configurations
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<computer_configuration>
<id>0</id>
<name>Configuration Name</name>
</computer_configuration>
findComputerConfigurationsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerconfigurations/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerconfigurations/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerconfigurations/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerconfigurations/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerconfigurations/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerconfigurations/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerconfigurations/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerconfigurations/id/{id}
Finds computer configurations by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>Configuration Name</name>
<description>string</description>
<type>Standard</type>
<parent>string</parent>
<packages/>
<scripts/>
<printers/>
<directory_bindings/>
<management>
<username>string</username>
<password>string</password>
<create_account>true</create_account>
<hide_account>true</hide_account>
<allow_ssh_for_management_only>true</allow_ssh_for_management_only>
</management>
<homepage>string</homepage>
<partitions>
<partition/>
</partitions>
</general>
updateComputerConfigurationById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/computerconfigurations/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/computerconfigurations/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerconfigurations/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerconfigurations/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/computerconfigurations/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/computerconfigurations/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerconfigurations/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /computerconfigurations/id/{id}
Updates an existing computer configuration by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createComputerConfigurationById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/computerconfigurations/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/computerconfigurations/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerconfigurations/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"id": 0,
"name": "Configuration Name",
"description": "string",
"type": "Standard",
"parent": "string",
"packages": {},
"scripts": {},
"printers": {},
"directory_bindings": {},
"management": {
"username": "string",
"password": "string",
"create_account": true,
"hide_account": true,
"allow_ssh_for_management_only": true
},
"homepage": "string",
"partitions": {
"partition": {}
}
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerconfigurations/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/computerconfigurations/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/computerconfigurations/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerconfigurations/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /computerconfigurations/id/{id}
Creates a new computer configuration by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | computer_configuration | true | Name of the configuration |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>Configuration Name</name>
<description>string</description>
<type>Standard</type>
<parent>string</parent>
<packages/>
<scripts/>
<printers/>
<directory_bindings/>
<management>
<username>string</username>
<password>string</password>
<create_account>true</create_account>
<hide_account>true</hide_account>
<allow_ssh_for_management_only>true</allow_ssh_for_management_only>
</management>
<homepage>string</homepage>
<partitions>
<partition/>
</partitions>
</general>
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | Created |
deleteComputerConfigurationById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/computerconfigurations/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/computerconfigurations/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerconfigurations/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerconfigurations/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/computerconfigurations/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/computerconfigurations/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerconfigurations/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /computerconfigurations/id/{id}
Deletes a computer configuration by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputerConfigurationsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerconfigurations/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerconfigurations/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerconfigurations/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerconfigurations/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerconfigurations/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerconfigurations/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerconfigurations/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerconfigurations/name/{name}
Finds computer configurations by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>Configuration Name</name>
<description>string</description>
<type>Standard</type>
<parent>string</parent>
<packages/>
<scripts/>
<printers/>
<directory_bindings/>
<management>
<username>string</username>
<password>string</password>
<create_account>true</create_account>
<hide_account>true</hide_account>
<allow_ssh_for_management_only>true</allow_ssh_for_management_only>
</management>
<homepage>string</homepage>
<partitions>
<partition/>
</partitions>
</general>
updateComputerConfigurationByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/computerconfigurations/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/computerconfigurations/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerconfigurations/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerconfigurations/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/computerconfigurations/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/computerconfigurations/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerconfigurations/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /computerconfigurations/name/{name}
Updates an existing computer configuration by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | integer | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteComputerConfigurationByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/computerconfigurations/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/computerconfigurations/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerconfigurations/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerconfigurations/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/computerconfigurations/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/computerconfigurations/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerconfigurations/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /computerconfigurations/name/{name}
Deletes a computer configuration by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | integer | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputerextensionattributes
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerextensionattributes \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerextensionattributes HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerextensionattributes',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerextensionattributes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerextensionattributes', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerextensionattributes', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerextensionattributes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerextensionattributes
Finds all computer extension attributes
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findComputerextensionattributesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerextensionattributes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerextensionattributes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerextensionattributes/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerextensionattributes/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerextensionattributes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerextensionattributes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerextensionattributes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerextensionattributes/id/{id}
Finds computer extension attributes by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Extension Attribute Name</name>
<description>string</description>
<data_type>String</data_type>
<input_type>
<type>script</type>
</input_type>
<inventory_display>General</inventory_display>
<recon_display>Computer</recon_display>
updateComputerextensionattributeById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/computerextensionattributes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/computerextensionattributes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerextensionattributes/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerextensionattributes/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/computerextensionattributes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/computerextensionattributes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerextensionattributes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /computerextensionattributes/id/{id}
Updates an existing computer extension attribute by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createComputerextensionattributeById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/computerextensionattributes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/computerextensionattributes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerextensionattributes/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "Extension Attribute Name",
"description": "string",
"data_type": "String",
"input_type": {
"type": "script"
},
"inventory_display": "General",
"recon_display": "Computer"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerextensionattributes/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/computerextensionattributes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/computerextensionattributes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerextensionattributes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /computerextensionattributes/id/{id}
Creates a new computer extension attribute by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | computer_extension_attribute | true | Extension attribute name |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Extension Attribute Name</name>
<description>string</description>
<data_type>String</data_type>
<input_type>
<type>script</type>
</input_type>
<inventory_display>General</inventory_display>
<recon_display>Computer</recon_display>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteComputerextensionattributeById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/computerextensionattributes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/computerextensionattributes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerextensionattributes/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerextensionattributes/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/computerextensionattributes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/computerextensionattributes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerextensionattributes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /computerextensionattributes/id/{id}
Deletes a computer extension attribute by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputerextensionattributesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerextensionattributes/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerextensionattributes/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerextensionattributes/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerextensionattributes/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerextensionattributes/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerextensionattributes/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerextensionattributes/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerextensionattributes/name/{name}
Finds computer extension attributes by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Extension Attribute Name</name>
<description>string</description>
<data_type>String</data_type>
<input_type>
<type>script</type>
</input_type>
<inventory_display>General</inventory_display>
<recon_display>Computer</recon_display>
updateComputerextensionattributeByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/computerextensionattributes/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/computerextensionattributes/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerextensionattributes/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerextensionattributes/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/computerextensionattributes/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/computerextensionattributes/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerextensionattributes/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /computerextensionattributes/name/{name}
Updates an existing computer extension attribute by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteComputerextensionattributeByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/computerextensionattributes/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/computerextensionattributes/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerextensionattributes/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerextensionattributes/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/computerextensionattributes/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/computerextensionattributes/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerextensionattributes/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /computerextensionattributes/name/{name}
Deletes a computer extension attribute by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputerGroups
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computergroups \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computergroups HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computergroups',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computergroups',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computergroups', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computergroups', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computergroups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computergroups
Finds all computer groups
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Group Name</name>
<is_smart>true</is_smart>
findComputerGroupsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computergroups/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computergroups/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computergroups/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computergroups/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computergroups/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computergroups/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computergroups/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computergroups/id/{id}
Finds computer groups by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Group Name</name>
<is_smart>true</is_smart>
updateComputerGroupById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/computergroups/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/computergroups/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computergroups/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computergroups/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/computergroups/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/computergroups/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computergroups/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /computergroups/id/{id}
Updates an existing computer group by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createComputerGroupById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/computergroups/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/computergroups/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computergroups/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "Group Name",
"is_smart": true,
"site": {
"id": 0,
"name": "string"
},
"criteria": {},
"computers": {
"computer": {
"id": 0,
"name": "string",
"mac_address": "string",
"alt_mac_address": "string",
"serial_number": "string"
}
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computergroups/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/computergroups/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/computergroups/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computergroups/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /computergroups/id/{id}
Creates a new computer group by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | computer_group | true | Name of the group |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Group Name</name>
<is_smart>true</is_smart>
<site>
<id>0</id>
<name>string</name>
</site>
<criteria/>
<computers>
<computer>
<id>0</id>
<name>string</name>
<mac_address>string</mac_address>
<alt_mac_address>string</alt_mac_address>
<serial_number>string</serial_number>
</computer>
</computers>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteComputerGroupById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/computergroups/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/computergroups/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computergroups/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computergroups/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/computergroups/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/computergroups/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computergroups/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /computergroups/id/{id}
Deletes a computer group by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputerGroupsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computergroups/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computergroups/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computergroups/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computergroups/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computergroups/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computergroups/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computergroups/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computergroups/name/{name}
Finds computer groups by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>Group Name</name>
<is_smart>true</is_smart>
updateComputerGroupByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/computergroups/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/computergroups/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computergroups/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computergroups/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/computergroups/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/computergroups/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computergroups/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /computergroups/name/{name}
Updates an existing computer group by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteComputerGroupByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/computergroups/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/computergroups/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computergroups/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computergroups/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/computergroups/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/computergroups/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computergroups/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /computergroups/name/{name}
Deletes a computer group by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputerHardwareSoftwareReportsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerhardwaresoftwarereports/id/{id}/{start_date}_{end_date} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerhardwaresoftwarereports/id/{id}/{start_date}_{end_date} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerhardwaresoftwarereports/id/{id}/{start_date}_{end_date}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerhardwaresoftwarereports/id/{id}/{start_date}_{end_date}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerhardwaresoftwarereports/id/{id}/{start_date}_{end_date}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerhardwaresoftwarereports/id/{id}/{start_date}_{end_date}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerhardwaresoftwarereports/id/{id}/{start_date}_{end_date}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerhardwaresoftwarereports/id/{id}/{start_date}_{end_date}
Finds hardware/software reports by computer ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | ID value to filter by |
| start_date | path | string | true | Start date (e.g. yyyy-mm-dd) |
| end_date | path | string | true | End date (e.g. yyyy-mm-dd) |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<hardware_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<operating_system>string</operating_system>
<service_pack>string</service_pack>
<NIC_speed>string</NIC_speed>
<optical_drive>string</optical_drive>
<make>string</make>
<model_identifier>string</model_identifier>
<serial_number>string</serial_number>
<processor_speed_mhz>0</processor_speed_mhz>
<processor_count>0</processor_count>
<core_count>0</core_count>
<total_ram_mb>0</total_ram_mb>
<open_ram_slots>0</open_ram_slots>
<total_harddrive_size>string</total_harddrive_size>
<boot_partition_used_percent>0</boot_partition_used_percent>
</hardware_report>
<font_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
<path>string</path>
</font_report>
<software_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
</software_report>
<plugin_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
<path>string</path>
</plugin_report>
findComputerHardwareSoftwareReportsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerhardwaresoftwarereports/name/{name}/{start_date}_{end_date} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerhardwaresoftwarereports/name/{name}/{start_date}_{end_date} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerhardwaresoftwarereports/name/{name}/{start_date}_{end_date}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerhardwaresoftwarereports/name/{name}/{start_date}_{end_date}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerhardwaresoftwarereports/name/{name}/{start_date}_{end_date}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerhardwaresoftwarereports/name/{name}/{start_date}_{end_date}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerhardwaresoftwarereports/name/{name}/{start_date}_{end_date}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerhardwaresoftwarereports/name/{name}/{start_date}_{end_date}
Finds hardware/software reports by computer name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
| start_date | path | string | true | Start date (e.g. yyyy-mm-dd) |
| end_date | path | string | true | End date (e.g. yyyy-mm-dd) |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<hardware_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<operating_system>string</operating_system>
<service_pack>string</service_pack>
<NIC_speed>string</NIC_speed>
<optical_drive>string</optical_drive>
<make>string</make>
<model_identifier>string</model_identifier>
<serial_number>string</serial_number>
<processor_speed_mhz>0</processor_speed_mhz>
<processor_count>0</processor_count>
<core_count>0</core_count>
<total_ram_mb>0</total_ram_mb>
<open_ram_slots>0</open_ram_slots>
<total_harddrive_size>string</total_harddrive_size>
<boot_partition_used_percent>0</boot_partition_used_percent>
</hardware_report>
<font_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
<path>string</path>
</font_report>
<software_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
</software_report>
<plugin_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
<path>string</path>
</plugin_report>
findComputerHardwareSoftwareReportsByUDID
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerhardwaresoftwarereports/udid/{udid}/{start_date}_{end_date} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerhardwaresoftwarereports/udid/{udid}/{start_date}_{end_date} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerhardwaresoftwarereports/udid/{udid}/{start_date}_{end_date}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerhardwaresoftwarereports/udid/{udid}/{start_date}_{end_date}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerhardwaresoftwarereports/udid/{udid}/{start_date}_{end_date}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerhardwaresoftwarereports/udid/{udid}/{start_date}_{end_date}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerhardwaresoftwarereports/udid/{udid}/{start_date}_{end_date}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerhardwaresoftwarereports/udid/{udid}/{start_date}_{end_date}
Finds hardware/software reports by computer UDID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| udid | path | string | true | UDID to filter by |
| start_date | path | string | true | Start date (e.g. yyyy-mm-dd) |
| end_date | path | string | true | End date (e.g. yyyy-mm-dd) |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<hardware_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<operating_system>string</operating_system>
<service_pack>string</service_pack>
<NIC_speed>string</NIC_speed>
<optical_drive>string</optical_drive>
<make>string</make>
<model_identifier>string</model_identifier>
<serial_number>string</serial_number>
<processor_speed_mhz>0</processor_speed_mhz>
<processor_count>0</processor_count>
<core_count>0</core_count>
<total_ram_mb>0</total_ram_mb>
<open_ram_slots>0</open_ram_slots>
<total_harddrive_size>string</total_harddrive_size>
<boot_partition_used_percent>0</boot_partition_used_percent>
</hardware_report>
<font_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
<path>string</path>
</font_report>
<software_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
</software_report>
<plugin_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
<path>string</path>
</plugin_report>
findComputerHardwareSoftwareReportsBySerial
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerhardwaresoftwarereports/serialnumber/{serialnumber}/{start_date}_{end_date} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerhardwaresoftwarereports/serialnumber/{serialnumber}/{start_date}_{end_date} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerhardwaresoftwarereports/serialnumber/{serialnumber}/{start_date}_{end_date}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerhardwaresoftwarereports/serialnumber/{serialnumber}/{start_date}_{end_date}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerhardwaresoftwarereports/serialnumber/{serialnumber}/{start_date}_{end_date}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerhardwaresoftwarereports/serialnumber/{serialnumber}/{start_date}_{end_date}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerhardwaresoftwarereports/serialnumber/{serialnumber}/{start_date}_{end_date}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerhardwaresoftwarereports/serialnumber/{serialnumber}/{start_date}_{end_date}
Finds hardware/software reports by computer serial number
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| serialnumber | path | string | true | Serial number to filter by |
| start_date | path | string | true | Start date (e.g. yyyy-mm-dd) |
| end_date | path | string | true | End date (e.g. yyyy-mm-dd) |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<hardware_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<operating_system>string</operating_system>
<service_pack>string</service_pack>
<NIC_speed>string</NIC_speed>
<optical_drive>string</optical_drive>
<make>string</make>
<model_identifier>string</model_identifier>
<serial_number>string</serial_number>
<processor_speed_mhz>0</processor_speed_mhz>
<processor_count>0</processor_count>
<core_count>0</core_count>
<total_ram_mb>0</total_ram_mb>
<open_ram_slots>0</open_ram_slots>
<total_harddrive_size>string</total_harddrive_size>
<boot_partition_used_percent>0</boot_partition_used_percent>
</hardware_report>
<font_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
<path>string</path>
</font_report>
<software_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
</software_report>
<plugin_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
<path>string</path>
</plugin_report>
findComputerHardwareSoftwareReportsByMacAddress
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerhardwaresoftwarereports/macaddress/{macaddress}/{start_date}_{end_date} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerhardwaresoftwarereports/macaddress/{macaddress}/{start_date}_{end_date} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerhardwaresoftwarereports/macaddress/{macaddress}/{start_date}_{end_date}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerhardwaresoftwarereports/macaddress/{macaddress}/{start_date}_{end_date}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerhardwaresoftwarereports/macaddress/{macaddress}/{start_date}_{end_date}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerhardwaresoftwarereports/macaddress/{macaddress}/{start_date}_{end_date}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerhardwaresoftwarereports/macaddress/{macaddress}/{start_date}_{end_date}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerhardwaresoftwarereports/macaddress/{macaddress}/{start_date}_{end_date}
Finds hardware/software reports by computer MAC address
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| macaddress | path | string | true | MAC address to filter by |
| start_date | path | string | true | Start date (e.g. yyyy-mm-dd) |
| end_date | path | string | true | End date (e.g. yyyy-mm-dd) |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<hardware_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<operating_system>string</operating_system>
<service_pack>string</service_pack>
<NIC_speed>string</NIC_speed>
<optical_drive>string</optical_drive>
<make>string</make>
<model_identifier>string</model_identifier>
<serial_number>string</serial_number>
<processor_speed_mhz>0</processor_speed_mhz>
<processor_count>0</processor_count>
<core_count>0</core_count>
<total_ram_mb>0</total_ram_mb>
<open_ram_slots>0</open_ram_slots>
<total_harddrive_size>string</total_harddrive_size>
<boot_partition_used_percent>0</boot_partition_used_percent>
</hardware_report>
<font_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
<path>string</path>
</font_report>
<software_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
</software_report>
<plugin_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
<path>string</path>
</plugin_report>
findComputerHardwareSoftwareReportsByIdSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerhardwaresoftwarereports/id/{id}/{start_date}_{end_date}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerhardwaresoftwarereports/id/{id}/{start_date}_{end_date}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerhardwaresoftwarereports/id/{id}/{start_date}_{end_date}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerhardwaresoftwarereports/id/{id}/{start_date}_{end_date}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerhardwaresoftwarereports/id/{id}/{start_date}_{end_date}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerhardwaresoftwarereports/id/{id}/{start_date}_{end_date}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerhardwaresoftwarereports/id/{id}/{start_date}_{end_date}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerhardwaresoftwarereports/id/{id}/{start_date}_{end_date}/subset/{subset}
Display subsets of information for computer hardware/software history
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | Computer ID to filter by |
| start_date | path | string | true | Start date (e.g. yyyy-mm-dd) |
| end_date | path | string | true | End date (e.g. yyyy-mm-dd) |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | Software |
| subset | Hardwre |
| subset | Fonts |
| subset | Plugins |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<hardware_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<operating_system>string</operating_system>
<service_pack>string</service_pack>
<NIC_speed>string</NIC_speed>
<optical_drive>string</optical_drive>
<make>string</make>
<model_identifier>string</model_identifier>
<serial_number>string</serial_number>
<processor_speed_mhz>0</processor_speed_mhz>
<processor_count>0</processor_count>
<core_count>0</core_count>
<total_ram_mb>0</total_ram_mb>
<open_ram_slots>0</open_ram_slots>
<total_harddrive_size>string</total_harddrive_size>
<boot_partition_used_percent>0</boot_partition_used_percent>
</hardware_report>
<font_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
<path>string</path>
</font_report>
<software_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
</software_report>
<plugin_report>
<date_time>string</date_time>
<date_time_epoch>0</date_time_epoch>
<date_time_utc>string</date_time_utc>
<type>string</type>
<name>string</name>
<version>string</version>
<path>string</path>
</plugin_report>
findComputerHistoryById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerhistory/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerhistory/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerhistory/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerhistory/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerhistory/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerhistory/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerhistory/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerhistory/id/{id}
Finds computer history by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | Computer ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findComputerHistoryByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerhistory/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerhistory/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerhistory/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerhistory/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerhistory/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerhistory/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerhistory/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerhistory/name/{name}
Finds computer history by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Computer Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findComputerHistoryByUDID
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerhistory/udid/{udid} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerhistory/udid/{udid} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerhistory/udid/{udid}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerhistory/udid/{udid}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerhistory/udid/{udid}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerhistory/udid/{udid}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerhistory/udid/{udid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerhistory/udid/{udid}
Finds computer history by UDID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| udid | path | string | true | Computer UDID to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findComputerHistoryBySerialNumber
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerhistory/serialnumber/{serialnumber} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerhistory/serialnumber/{serialnumber} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerhistory/serialnumber/{serialnumber}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerhistory/serialnumber/{serialnumber}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerhistory/serialnumber/{serialnumber}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerhistory/serialnumber/{serialnumber}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerhistory/serialnumber/{serialnumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerhistory/serialnumber/{serialnumber}
Finds computer history by serial number
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| serialnumber | path | string | true | Computer Serial Number to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findComputerHistoryByMacAddress
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerhistory/macaddress/{macaddress} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerhistory/macaddress/{macaddress} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerhistory/macaddress/{macaddress}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerhistory/macaddress/{macaddress}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerhistory/macaddress/{macaddress}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerhistory/macaddress/{macaddress}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerhistory/macaddress/{macaddress}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerhistory/macaddress/{macaddress}
Finds computer history by MAC address
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| macaddress | path | string | true | Computer Mac Address to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findComputerHistoryByIdSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerhistory/id/{id}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerhistory/id/{id}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerhistory/id/{id}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerhistory/id/{id}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerhistory/id/{id}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerhistory/id/{id}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerhistory/id/{id}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerhistory/id/{id}/subset/{subset}
Display subsets of information for a computer history
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | Computer ID to filter by |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | General |
| subset | ComputerUsageLogs |
| subset | Audits |
| subset | PolicyLogs |
| subset | CasperRemoteLogs |
| subset | ScreenSharingLogs |
| subset | CasperImagingLogs |
| subset | Commands |
| subset | UserLocation |
| subset | MacAppStoreApplications |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findComputerInventoryCollection
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computerinventorycollection \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computerinventorycollection HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerinventorycollection',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerinventorycollection',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computerinventorycollection', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computerinventorycollection', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerinventorycollection");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computerinventorycollection
Finds the JSS computer inventory collection information
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<local_user_accounts>true</local_user_accounts>
<home_directory_sizes>true</home_directory_sizes>
<hidden_accounts>true</hidden_accounts>
<printers>true</printers>
<active_services>true</active_services>
<mobile_device_app_purchasing_info>true</mobile_device_app_purchasing_info>
<computer_location_information>true</computer_location_information>
<package_receipts>true</package_receipts>
<available_software_updates>true</available_software_updates>
<inclue_applications>true</inclue_applications>
<inclue_fonts>true</inclue_fonts>
<inclue_plugins>true</inclue_plugins>
<applications>
<application>
<path>~/Applications</path>
<platform>Mac</platform>
</application>
</applications>
<fonts>
<font>
<path>~/Library/Fonts</path>
<platform>Mac</platform>
</font>
</fonts>
<plugins>
<plugin>
<path>~/Library/Internet Plug-Ins</path>
<platform>Mac</platform>
</plugin>
</plugins>
updateComputerInventoryCollection
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/computerinventorycollection \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/computerinventorycollection HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computerinventorycollection',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computerinventorycollection',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/computerinventorycollection', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/computerinventorycollection', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computerinventorycollection");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /computerinventorycollection
Updates the JSS computer inventory collection information
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
findComputerManagementById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computermanagement/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computermanagement/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computermanagement/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computermanagement/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computermanagement/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computermanagement/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computermanagement/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computermanagement/id/{id}
Finds computer management information by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | Computer ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findComputerManagementByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computermanagement/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computermanagement/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computermanagement/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computermanagement/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computermanagement/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computermanagement/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computermanagement/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computermanagement/name/{name}
Finds computer management information by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Computer Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findComputerManagementByUDID
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computermanagement/udid/{udid} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computermanagement/udid/{udid} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computermanagement/udid/{udid}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computermanagement/udid/{udid}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computermanagement/udid/{udid}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computermanagement/udid/{udid}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computermanagement/udid/{udid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computermanagement/udid/{udid}
Finds computer management information by UDID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| udid | path | string | true | Computer UDID to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findComputerManagementBySerialNumber
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computermanagement/serialnumber/{serialnumber} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computermanagement/serialnumber/{serialnumber} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computermanagement/serialnumber/{serialnumber}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computermanagement/serialnumber/{serialnumber}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computermanagement/serialnumber/{serialnumber}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computermanagement/serialnumber/{serialnumber}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computermanagement/serialnumber/{serialnumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computermanagement/serialnumber/{serialnumber}
Finds computer management information by serial number
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| serialnumber | path | string | true | Computer Serial Number to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findComputerManagementByMacAddress
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computermanagement/macaddress/{macaddress} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computermanagement/macaddress/{macaddress} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computermanagement/macaddress/{macaddress}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computermanagement/macaddress/{macaddress}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computermanagement/macaddress/{macaddress}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computermanagement/macaddress/{macaddress}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computermanagement/macaddress/{macaddress}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computermanagement/macaddress/{macaddress}
Finds computer management information by MAC address
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| macaddress | path | string | true | Computer Mac Address to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findComputerManagementByIdSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computermanagement/id/{id}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computermanagement/id/{id}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computermanagement/id/{id}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computermanagement/id/{id}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computermanagement/id/{id}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computermanagement/id/{id}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computermanagement/id/{id}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computermanagement/id/{id}/subset/{subset}
Display subsets of management information for a computer
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | Computer ID to filter by |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | General |
| subset | Policies |
| subset | Ebooks |
| subset | MacAppStoreApps |
| subset | OSXConfigurationProfiles |
| subset | ManagedPreferenceProfiles |
| subset | RestrictedSoftware |
| subset | SmartGroups |
| subset | StaticGroups |
| subset | PatchReportingSoftwareTitles |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findComputerManagementByIdUsername
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computermanagement/id/{id}/username/{username} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computermanagement/id/{id}/username/{username} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computermanagement/id/{id}/username/{username}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computermanagement/id/{id}/username/{username}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computermanagement/id/{id}/username/{username}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computermanagement/id/{id}/username/{username}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computermanagement/id/{id}/username/{username}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computermanagement/id/{id}/username/{username}
Display management information for a computer and username
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | Computer ID to filter by |
| username | path | string | true | Username to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findComputerManagementByIdUsernameSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computermanagement/id/{id}/username/{username}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computermanagement/id/{id}/username/{username}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computermanagement/id/{id}/username/{username}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computermanagement/id/{id}/username/{username}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computermanagement/id/{id}/username/{username}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computermanagement/id/{id}/username/{username}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computermanagement/id/{id}/username/{username}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computermanagement/id/{id}/username/{username}/subset/{subset}
Display subsets of management information for a computer and username
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | Computer ID to filter by |
| username | path | string | true | Username to filter by |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | General |
| subset | Policies |
| subset | Ebooks |
| subset | MacAppStoreApps |
| subset | OSXConfigurationProfiles |
| subset | ManagedPreferenceProfiles |
| subset | RestrictedSoftware |
| subset | SmartGroups |
| subset | StaticGroups |
| subset | PatchReportingSoftwareTitles |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findComputerManagementByIdPatchFilter
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computermanagement/id/{id}/patchfilter/{filter} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computermanagement/id/{id}/patchfilter/{filter} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computermanagement/id/{id}/patchfilter/{filter}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computermanagement/id/{id}/patchfilter/{filter}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computermanagement/id/{id}/patchfilter/{filter}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computermanagement/id/{id}/patchfilter/{filter}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computermanagement/id/{id}/patchfilter/{filter}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computermanagement/id/{id}/patchfilter/{filter}
Display patch management information for a computer and filter
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | Computer ID to filter by |
| filter | path | string | true | filter to apply |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findComputers
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computers \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computers HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computers', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computers', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computers
Finds all computers
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findComputersBasic
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computers/subset/basic \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computers/subset/basic HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/subset/basic',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/subset/basic',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computers/subset/basic', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computers/subset/basic', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/subset/basic");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computers/subset/basic
Finds basic information for all computers
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<computers>
<computer>
<id>0</id>
<name>string</name>
<managed>true</managed>
<username>string</username>
<model>string</model>
<department>string</department>
<building>string</building>
<mac_address>string</mac_address>
<udid>string</udid>
<serial_number>string</serial_number>
<report_date_utc>string</report_date_utc>
<report_date_epoch>0</report_date_epoch>
</computer>
</computers>
matchComputers
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computers/match/{match} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computers/match/{match} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/match/{match}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/match/{match}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computers/match/{match}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computers/match/{match}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/match/{match}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computers/match/{match}
Searches for computers that match the provided parameter
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| match | path | string | true | Name, mac address, etc. to filter by. Match uses the same format as the general search in the JSS. For instance, admin* can be used to match computer names that begin with admin |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
matchComputersNames
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computers/match/name/{matchname} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computers/match/name/{matchname} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/match/name/{matchname}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/match/name/{matchname}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computers/match/name/{matchname}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computers/match/name/{matchname}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/match/name/{matchname}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computers/match/name/{matchname}
Searches for computers that match the provided name parameter
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| matchname | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputersById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computers/id/{id}
Finds computers by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<mac_address>string</mac_address>
<alt_mac_address>string</alt_mac_address>
<ip_address>string</ip_address>
<last_reported_ip>string</last_reported_ip>
<serial_number>string</serial_number>
<udid>string</udid>
<jamf_version>string</jamf_version>
<platform>string</platform>
<barcode_1>string</barcode_1>
<barcode_2>string</barcode_2>
<asset_tag>string</asset_tag>
<remote_management>
<managed>true</managed>
<management_username>string</management_username>
</remote_management>
<mdm_capable>true</mdm_capable>
<mdm_capable_users>
<mdm_capable_user>string</mdm_capable_user>
</mdm_capable_users>
<report_date>string</report_date>
<report_date_epoch>0</report_date_epoch>
<report_date_utc>string</report_date_utc>
<last_contact_time>string</last_contact_time>
<last_contact_time_epoch>0</last_contact_time_epoch>
<last_contact_time_utc>string</last_contact_time_utc>
<initial_entry_date>string</initial_entry_date>
<initial_entry_date_epoch>0</initial_entry_date_epoch>
<initial_entry_date_utc>string</initial_entry_date_utc>
<last_cloud_backup_date_epoch>0</last_cloud_backup_date_epoch>
<last_cloud_backup_date_utc>string</last_cloud_backup_date_utc>
<last_enrolled_date_epoch>0</last_enrolled_date_epoch>
<last_enrolled_date_utc>string</last_enrolled_date_utc>
<distribution_point>string</distribution_point>
<sus>string</sus>
<netboot_server>string</netboot_server>
<site>
<id>0</id>
<name>string</name>
</site>
<itunes_store_account_is_active>true</itunes_store_account_is_active>
</general>
<location>
<username>string</username>
<realname>string</realname>
<real_name>string</real_name>
<email_address>string</email_address>
<position>string</position>
<phone>string</phone>
<phone_number>string</phone_number>
<department>string</department>
<building>string</building>
<room>string</room>
</location>
<purchasing>
<is_purchased>true</is_purchased>
<is_leased>true</is_leased>
<po_number>string</po_number>
<vendor>string</vendor>
<applecare_id>string</applecare_id>
<purchase_price>string</purchase_price>
<purchasing_account>string</purchasing_account>
<po_date>string</po_date>
<po_date_epoch>0</po_date_epoch>
<po_date_utc>string</po_date_utc>
<warranty_expires>string</warranty_expires>
<warranty_expires_epoch>0</warranty_expires_epoch>
<warranty_expires_utc>string</warranty_expires_utc>
<lease_expires>string</lease_expires>
<lease_expires_epoch>0</lease_expires_epoch>
<lease_expires_utc>string</lease_expires_utc>
<life_expectancy>0</life_expectancy>
<purchasing_contact>string</purchasing_contact>
</purchasing>
updateComputerById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/computers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/computers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/computers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/computers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /computers/id/{id}
Updates an existing computer by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createComputerById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/computers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/computers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/id/{id}',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/computers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/computers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /computers/id/{id}
Creates a computer
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteComputerById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/computers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/computers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/computers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/computers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /computers/id/{id}
Deletes a computer by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputersByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computers/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computers/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computers/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computers/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computers/name/{name}
Finds the first computer with the given name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<mac_address>string</mac_address>
<alt_mac_address>string</alt_mac_address>
<ip_address>string</ip_address>
<last_reported_ip>string</last_reported_ip>
<serial_number>string</serial_number>
<udid>string</udid>
<jamf_version>string</jamf_version>
<platform>string</platform>
<barcode_1>string</barcode_1>
<barcode_2>string</barcode_2>
<asset_tag>string</asset_tag>
<remote_management>
<managed>true</managed>
<management_username>string</management_username>
</remote_management>
<mdm_capable>true</mdm_capable>
<mdm_capable_users>
<mdm_capable_user>string</mdm_capable_user>
</mdm_capable_users>
<report_date>string</report_date>
<report_date_epoch>0</report_date_epoch>
<report_date_utc>string</report_date_utc>
<last_contact_time>string</last_contact_time>
<last_contact_time_epoch>0</last_contact_time_epoch>
<last_contact_time_utc>string</last_contact_time_utc>
<initial_entry_date>string</initial_entry_date>
<initial_entry_date_epoch>0</initial_entry_date_epoch>
<initial_entry_date_utc>string</initial_entry_date_utc>
<last_cloud_backup_date_epoch>0</last_cloud_backup_date_epoch>
<last_cloud_backup_date_utc>string</last_cloud_backup_date_utc>
<last_enrolled_date_epoch>0</last_enrolled_date_epoch>
<last_enrolled_date_utc>string</last_enrolled_date_utc>
<distribution_point>string</distribution_point>
<sus>string</sus>
<netboot_server>string</netboot_server>
<site>
<id>0</id>
<name>string</name>
</site>
<itunes_store_account_is_active>true</itunes_store_account_is_active>
</general>
<location>
<username>string</username>
<realname>string</realname>
<real_name>string</real_name>
<email_address>string</email_address>
<position>string</position>
<phone>string</phone>
<phone_number>string</phone_number>
<department>string</department>
<building>string</building>
<room>string</room>
</location>
<purchasing>
<is_purchased>true</is_purchased>
<is_leased>true</is_leased>
<po_number>string</po_number>
<vendor>string</vendor>
<applecare_id>string</applecare_id>
<purchase_price>string</purchase_price>
<purchasing_account>string</purchasing_account>
<po_date>string</po_date>
<po_date_epoch>0</po_date_epoch>
<po_date_utc>string</po_date_utc>
<warranty_expires>string</warranty_expires>
<warranty_expires_epoch>0</warranty_expires_epoch>
<warranty_expires_utc>string</warranty_expires_utc>
<lease_expires>string</lease_expires>
<lease_expires_epoch>0</lease_expires_epoch>
<lease_expires_utc>string</lease_expires_utc>
<life_expectancy>0</life_expectancy>
<purchasing_contact>string</purchasing_contact>
</purchasing>
updateComputerByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/computers/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/computers/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/computers/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/computers/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /computers/name/{name}
Updates an existing computer by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteComputerByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/computers/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/computers/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/computers/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/computers/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /computers/name/{name}
Deletes a computer by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputersByUDID
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computers/udid/{udid} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computers/udid/{udid} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/udid/{udid}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/udid/{udid}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computers/udid/{udid}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computers/udid/{udid}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/udid/{udid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computers/udid/{udid}
Finds computers by UDID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| udid | path | string | true | UDID to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<mac_address>string</mac_address>
<alt_mac_address>string</alt_mac_address>
<ip_address>string</ip_address>
<last_reported_ip>string</last_reported_ip>
<serial_number>string</serial_number>
<udid>string</udid>
<jamf_version>string</jamf_version>
<platform>string</platform>
<barcode_1>string</barcode_1>
<barcode_2>string</barcode_2>
<asset_tag>string</asset_tag>
<remote_management>
<managed>true</managed>
<management_username>string</management_username>
</remote_management>
<mdm_capable>true</mdm_capable>
<mdm_capable_users>
<mdm_capable_user>string</mdm_capable_user>
</mdm_capable_users>
<report_date>string</report_date>
<report_date_epoch>0</report_date_epoch>
<report_date_utc>string</report_date_utc>
<last_contact_time>string</last_contact_time>
<last_contact_time_epoch>0</last_contact_time_epoch>
<last_contact_time_utc>string</last_contact_time_utc>
<initial_entry_date>string</initial_entry_date>
<initial_entry_date_epoch>0</initial_entry_date_epoch>
<initial_entry_date_utc>string</initial_entry_date_utc>
<last_cloud_backup_date_epoch>0</last_cloud_backup_date_epoch>
<last_cloud_backup_date_utc>string</last_cloud_backup_date_utc>
<last_enrolled_date_epoch>0</last_enrolled_date_epoch>
<last_enrolled_date_utc>string</last_enrolled_date_utc>
<distribution_point>string</distribution_point>
<sus>string</sus>
<netboot_server>string</netboot_server>
<site>
<id>0</id>
<name>string</name>
</site>
<itunes_store_account_is_active>true</itunes_store_account_is_active>
</general>
<location>
<username>string</username>
<realname>string</realname>
<real_name>string</real_name>
<email_address>string</email_address>
<position>string</position>
<phone>string</phone>
<phone_number>string</phone_number>
<department>string</department>
<building>string</building>
<room>string</room>
</location>
<purchasing>
<is_purchased>true</is_purchased>
<is_leased>true</is_leased>
<po_number>string</po_number>
<vendor>string</vendor>
<applecare_id>string</applecare_id>
<purchase_price>string</purchase_price>
<purchasing_account>string</purchasing_account>
<po_date>string</po_date>
<po_date_epoch>0</po_date_epoch>
<po_date_utc>string</po_date_utc>
<warranty_expires>string</warranty_expires>
<warranty_expires_epoch>0</warranty_expires_epoch>
<warranty_expires_utc>string</warranty_expires_utc>
<lease_expires>string</lease_expires>
<lease_expires_epoch>0</lease_expires_epoch>
<lease_expires_utc>string</lease_expires_utc>
<life_expectancy>0</life_expectancy>
<purchasing_contact>string</purchasing_contact>
</purchasing>
updateComputerByUDID
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/computers/udid/{udid} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/computers/udid/{udid} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/udid/{udid}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/udid/{udid}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/computers/udid/{udid}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/computers/udid/{udid}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/udid/{udid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /computers/udid/{udid}
Updates an existing computer by UDID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| udid | path | string | true | UDID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteComputerByUDID
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/computers/udid/{udid} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/computers/udid/{udid} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/udid/{udid}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/udid/{udid}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/computers/udid/{udid}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/computers/udid/{udid}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/udid/{udid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /computers/udid/{udid}
Deletes a computer by UDID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| udid | path | string | true | UDID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputersBySerialNumber
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computers/serialnumber/{serialnumber} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computers/serialnumber/{serialnumber} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/serialnumber/{serialnumber}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/serialnumber/{serialnumber}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computers/serialnumber/{serialnumber}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computers/serialnumber/{serialnumber}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/serialnumber/{serialnumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computers/serialnumber/{serialnumber}
Finds computers by serial number
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| serialnumber | path | string | true | Serial number to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<mac_address>string</mac_address>
<alt_mac_address>string</alt_mac_address>
<ip_address>string</ip_address>
<last_reported_ip>string</last_reported_ip>
<serial_number>string</serial_number>
<udid>string</udid>
<jamf_version>string</jamf_version>
<platform>string</platform>
<barcode_1>string</barcode_1>
<barcode_2>string</barcode_2>
<asset_tag>string</asset_tag>
<remote_management>
<managed>true</managed>
<management_username>string</management_username>
</remote_management>
<mdm_capable>true</mdm_capable>
<mdm_capable_users>
<mdm_capable_user>string</mdm_capable_user>
</mdm_capable_users>
<report_date>string</report_date>
<report_date_epoch>0</report_date_epoch>
<report_date_utc>string</report_date_utc>
<last_contact_time>string</last_contact_time>
<last_contact_time_epoch>0</last_contact_time_epoch>
<last_contact_time_utc>string</last_contact_time_utc>
<initial_entry_date>string</initial_entry_date>
<initial_entry_date_epoch>0</initial_entry_date_epoch>
<initial_entry_date_utc>string</initial_entry_date_utc>
<last_cloud_backup_date_epoch>0</last_cloud_backup_date_epoch>
<last_cloud_backup_date_utc>string</last_cloud_backup_date_utc>
<last_enrolled_date_epoch>0</last_enrolled_date_epoch>
<last_enrolled_date_utc>string</last_enrolled_date_utc>
<distribution_point>string</distribution_point>
<sus>string</sus>
<netboot_server>string</netboot_server>
<site>
<id>0</id>
<name>string</name>
</site>
<itunes_store_account_is_active>true</itunes_store_account_is_active>
</general>
<location>
<username>string</username>
<realname>string</realname>
<real_name>string</real_name>
<email_address>string</email_address>
<position>string</position>
<phone>string</phone>
<phone_number>string</phone_number>
<department>string</department>
<building>string</building>
<room>string</room>
</location>
<purchasing>
<is_purchased>true</is_purchased>
<is_leased>true</is_leased>
<po_number>string</po_number>
<vendor>string</vendor>
<applecare_id>string</applecare_id>
<purchase_price>string</purchase_price>
<purchasing_account>string</purchasing_account>
<po_date>string</po_date>
<po_date_epoch>0</po_date_epoch>
<po_date_utc>string</po_date_utc>
<warranty_expires>string</warranty_expires>
<warranty_expires_epoch>0</warranty_expires_epoch>
<warranty_expires_utc>string</warranty_expires_utc>
<lease_expires>string</lease_expires>
<lease_expires_epoch>0</lease_expires_epoch>
<lease_expires_utc>string</lease_expires_utc>
<life_expectancy>0</life_expectancy>
<purchasing_contact>string</purchasing_contact>
</purchasing>
updateComputerBySerialNumber
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/computers/serialnumber/{serialnumber} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/computers/serialnumber/{serialnumber} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/serialnumber/{serialnumber}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/serialnumber/{serialnumber}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/computers/serialnumber/{serialnumber}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/computers/serialnumber/{serialnumber}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/serialnumber/{serialnumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /computers/serialnumber/{serialnumber}
Updates an existing computer by serial number
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| serialnumber | path | string | true | Serial number value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteComputerBySerialNumber
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/computers/serialnumber/{serialnumber} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/computers/serialnumber/{serialnumber} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/serialnumber/{serialnumber}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/serialnumber/{serialnumber}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/computers/serialnumber/{serialnumber}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/computers/serialnumber/{serialnumber}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/serialnumber/{serialnumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /computers/serialnumber/{serialnumber}
Deletes a computer by serial number
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| serialnumber | path | string | true | Serial number value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputersByMacAddress
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computers/macaddress/{macaddress} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computers/macaddress/{macaddress} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/macaddress/{macaddress}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/macaddress/{macaddress}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computers/macaddress/{macaddress}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computers/macaddress/{macaddress}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/macaddress/{macaddress}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computers/macaddress/{macaddress}
Finds computers by MAC address
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| macaddress | path | string | true | Mac address to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<mac_address>string</mac_address>
<alt_mac_address>string</alt_mac_address>
<ip_address>string</ip_address>
<last_reported_ip>string</last_reported_ip>
<serial_number>string</serial_number>
<udid>string</udid>
<jamf_version>string</jamf_version>
<platform>string</platform>
<barcode_1>string</barcode_1>
<barcode_2>string</barcode_2>
<asset_tag>string</asset_tag>
<remote_management>
<managed>true</managed>
<management_username>string</management_username>
</remote_management>
<mdm_capable>true</mdm_capable>
<mdm_capable_users>
<mdm_capable_user>string</mdm_capable_user>
</mdm_capable_users>
<report_date>string</report_date>
<report_date_epoch>0</report_date_epoch>
<report_date_utc>string</report_date_utc>
<last_contact_time>string</last_contact_time>
<last_contact_time_epoch>0</last_contact_time_epoch>
<last_contact_time_utc>string</last_contact_time_utc>
<initial_entry_date>string</initial_entry_date>
<initial_entry_date_epoch>0</initial_entry_date_epoch>
<initial_entry_date_utc>string</initial_entry_date_utc>
<last_cloud_backup_date_epoch>0</last_cloud_backup_date_epoch>
<last_cloud_backup_date_utc>string</last_cloud_backup_date_utc>
<last_enrolled_date_epoch>0</last_enrolled_date_epoch>
<last_enrolled_date_utc>string</last_enrolled_date_utc>
<distribution_point>string</distribution_point>
<sus>string</sus>
<netboot_server>string</netboot_server>
<site>
<id>0</id>
<name>string</name>
</site>
<itunes_store_account_is_active>true</itunes_store_account_is_active>
</general>
<location>
<username>string</username>
<realname>string</realname>
<real_name>string</real_name>
<email_address>string</email_address>
<position>string</position>
<phone>string</phone>
<phone_number>string</phone_number>
<department>string</department>
<building>string</building>
<room>string</room>
</location>
<purchasing>
<is_purchased>true</is_purchased>
<is_leased>true</is_leased>
<po_number>string</po_number>
<vendor>string</vendor>
<applecare_id>string</applecare_id>
<purchase_price>string</purchase_price>
<purchasing_account>string</purchasing_account>
<po_date>string</po_date>
<po_date_epoch>0</po_date_epoch>
<po_date_utc>string</po_date_utc>
<warranty_expires>string</warranty_expires>
<warranty_expires_epoch>0</warranty_expires_epoch>
<warranty_expires_utc>string</warranty_expires_utc>
<lease_expires>string</lease_expires>
<lease_expires_epoch>0</lease_expires_epoch>
<lease_expires_utc>string</lease_expires_utc>
<life_expectancy>0</life_expectancy>
<purchasing_contact>string</purchasing_contact>
</purchasing>
updateComputerByMacAddress
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/computers/macaddress/{macaddress} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/computers/macaddress/{macaddress} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/macaddress/{macaddress}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/macaddress/{macaddress}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/computers/macaddress/{macaddress}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/computers/macaddress/{macaddress}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/macaddress/{macaddress}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /computers/macaddress/{macaddress}
Updates an existing computer by MAC address
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| macaddress | path | string | true | MAC address value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteComputerByMacAddress
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/computers/macaddress/{macaddress} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/computers/macaddress/{macaddress} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/macaddress/{macaddress}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/macaddress/{macaddress}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/computers/macaddress/{macaddress}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/computers/macaddress/{macaddress}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/macaddress/{macaddress}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /computers/macaddress/{macaddress}
Deletes a computer by MAC address
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| macaddress | path | string | true | MAC address value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputersByIdSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/computers/id/{id}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/computers/id/{id}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/computers/id/{id}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/computers/id/{id}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/computers/id/{id}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/computers/id/{id}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/computers/id/{id}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /computers/id/{id}/subset/{subset}
Display subsets of information for a computer
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID to filter by |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | General |
| subset | Location |
| subset | Purchasing |
| subset | Peripherals |
| subset | Hardware |
| subset | Certificates |
| subset | Software |
| subset | ExtensionAttributes |
| subset | GroupsAccounts |
| subset | iphones |
| subset | ConfigurationProfiles |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findDepartments
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/departments \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/departments HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/departments',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/departments',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/departments', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/departments', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/departments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /departments
Finds all departments
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findDepartmentsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/departments/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/departments/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/departments/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/departments/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/departments/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/departments/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/departments/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /departments/id/{id}
Finds departments by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
updateDepartmentById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/departments/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/departments/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/departments/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/departments/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/departments/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/departments/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/departments/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /departments/id/{id}
Updates an existing department by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createDepartmentById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/departments/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/departments/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/departments/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/departments/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/departments/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/departments/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/departments/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /departments/id/{id}
Creates a new department by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | department | true | Department name |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteDepartmentById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/departments/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/departments/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/departments/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/departments/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/departments/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/departments/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/departments/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /departments/id/{id}
Deletes a department by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findDepartmentsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/departments/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/departments/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/departments/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/departments/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/departments/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/departments/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/departments/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /departments/name/{name}
Finds departments by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
updateDepartmentByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/departments/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/departments/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/departments/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/departments/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/departments/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/departments/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/departments/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /departments/name/{name}
Updates an existing department by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteDepartmentByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/departments/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/departments/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/departments/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/departments/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/departments/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/departments/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/departments/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /departments/name/{name}
Deletes a department by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findDirectoryBindings
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/directorybindings \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/directorybindings HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/directorybindings',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/directorybindings',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/directorybindings', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/directorybindings', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/directorybindings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /directorybindings
Finds all directory bindings
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findDirectoryBindingsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/directorybindings/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/directorybindings/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/directorybindings/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/directorybindings/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/directorybindings/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/directorybindings/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/directorybindings/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /directorybindings/id/{id}
Finds directory bindings by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<priority>0</priority>
<domain>string</domain>
<username>string</username>
<password>string</password>
<computer_ou>string</computer_ou>
<type>string</type>
updateDirectoryBindingById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/directorybindings/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/directorybindings/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/directorybindings/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/directorybindings/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/directorybindings/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/directorybindings/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/directorybindings/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /directorybindings/id/{id}
Updates an existing directory binding by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createDirectoryBindingById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/directorybindings/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/directorybindings/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/directorybindings/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"priority": 0,
"domain": "string",
"username": "string",
"password": "string",
"computer_ou": "string",
"type": "string"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/directorybindings/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/directorybindings/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/directorybindings/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/directorybindings/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /directorybindings/id/{id}
Creates a new directory binding by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | directory_binding | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<priority>0</priority>
<domain>string</domain>
<username>string</username>
<password>string</password>
<computer_ou>string</computer_ou>
<type>string</type>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteDirectoryBindingById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/directorybindings/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/directorybindings/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/directorybindings/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/directorybindings/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/directorybindings/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/directorybindings/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/directorybindings/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /directorybindings/id/{id}
Deletes a directory binding by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findDirectoryBindingsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/directorybindings/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/directorybindings/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/directorybindings/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/directorybindings/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/directorybindings/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/directorybindings/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/directorybindings/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /directorybindings/name/{name}
Finds directory bindings by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<priority>0</priority>
<domain>string</domain>
<username>string</username>
<password>string</password>
<computer_ou>string</computer_ou>
<type>string</type>
updateDirectoryBindingByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/directorybindings/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/directorybindings/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/directorybindings/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/directorybindings/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/directorybindings/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/directorybindings/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/directorybindings/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /directorybindings/name/{name}
Updates an existing directory binding by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteDirectoryBindingByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/directorybindings/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/directorybindings/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/directorybindings/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/directorybindings/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/directorybindings/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/directorybindings/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/directorybindings/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /directorybindings/name/{name}
Deletes a directory binding by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findDiskEncryptionConfigurations
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/diskencryptionconfigurations \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/diskencryptionconfigurations HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/diskencryptionconfigurations',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/diskencryptionconfigurations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/diskencryptionconfigurations', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/diskencryptionconfigurations', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/diskencryptionconfigurations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /diskencryptionconfigurations
Finds all disk encryption configurations
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findDiskEncryptionConfigurationsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/diskencryptionconfigurations/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/diskencryptionconfigurations/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/diskencryptionconfigurations/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/diskencryptionconfigurations/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/diskencryptionconfigurations/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/diskencryptionconfigurations/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/diskencryptionconfigurations/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /diskencryptionconfigurations/id/{id}
Finds disk encryption configurations by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<key_type>Individual</key_type>
<file_vault_enabled_users>Management Account</file_vault_enabled_users>
updateDiskEncryptionConfigurationById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/diskencryptionconfigurations/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/diskencryptionconfigurations/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/diskencryptionconfigurations/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/diskencryptionconfigurations/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/diskencryptionconfigurations/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/diskencryptionconfigurations/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/diskencryptionconfigurations/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /diskencryptionconfigurations/id/{id}
Updates an existing disk encryption configuration by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createDiskEncryptionConfigurationById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/diskencryptionconfigurations/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/diskencryptionconfigurations/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/diskencryptionconfigurations/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"key_type": "Individual",
"file_vault_enabled_users": "Management Account"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/diskencryptionconfigurations/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/diskencryptionconfigurations/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/diskencryptionconfigurations/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/diskencryptionconfigurations/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /diskencryptionconfigurations/id/{id}
Creates a new disk encryption configuration by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | disk_encryption_configuration | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<key_type>Individual</key_type>
<file_vault_enabled_users>Management Account</file_vault_enabled_users>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteDiskEncryptionConfigurationById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/diskencryptionconfigurations/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/diskencryptionconfigurations/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/diskencryptionconfigurations/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/diskencryptionconfigurations/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/diskencryptionconfigurations/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/diskencryptionconfigurations/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/diskencryptionconfigurations/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /diskencryptionconfigurations/id/{id}
Deletes a disk encryption configuration by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findDiskEncryptionConfigurationsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/diskencryptionconfigurations/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/diskencryptionconfigurations/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/diskencryptionconfigurations/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/diskencryptionconfigurations/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/diskencryptionconfigurations/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/diskencryptionconfigurations/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/diskencryptionconfigurations/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /diskencryptionconfigurations/name/{name}
Finds disk encryption configurations by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<key_type>Individual</key_type>
<file_vault_enabled_users>Management Account</file_vault_enabled_users>
updateDiskEncryptionConfigurationByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/diskencryptionconfigurations/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/diskencryptionconfigurations/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/diskencryptionconfigurations/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/diskencryptionconfigurations/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/diskencryptionconfigurations/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/diskencryptionconfigurations/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/diskencryptionconfigurations/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /diskencryptionconfigurations/name/{name}
Updates an existing disk encryption configuration by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteDiskEncryptionConfigurationByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/diskencryptionconfigurations/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/diskencryptionconfigurations/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/diskencryptionconfigurations/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/diskencryptionconfigurations/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/diskencryptionconfigurations/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/diskencryptionconfigurations/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/diskencryptionconfigurations/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /diskencryptionconfigurations/name/{name}
Deletes a disk encryption configuration by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findDistributionPoints
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/distributionpoints \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/distributionpoints HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/distributionpoints',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/distributionpoints',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/distributionpoints', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/distributionpoints', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/distributionpoints");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /distributionpoints
Finds all distribution points
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findDistributionPointsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/distributionpoints/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/distributionpoints/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/distributionpoints/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/distributionpoints/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/distributionpoints/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/distributionpoints/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/distributionpoints/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /distributionpoints/id/{id}
Finds distribution points by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<ip_address>string</ip_address>
<is_master>true</is_master>
<failover_point>string</failover_point>
<failover_point_url>string</failover_point_url>
<enable_load_balancing>true</enable_load_balancing>
<local_path>string</local_path>
<ssh_username>string</ssh_username>
<password>string</password>
<connection_type>SMB</connection_type>
<share_name>string</share_name>
<workgroup_or_domain>string</workgroup_or_domain>
<share_port>0</share_port>
<read_only_username>string</read_only_username>
<read_only_password>string</read_only_password>
<read_write_username>string</read_write_username>
<read_write_password>string</read_write_password>
<http_downloads_enabled>true</http_downloads_enabled>
<http_url>string</http_url>
<context>string</context>
<protocol>string</protocol>
<port>0</port>
<no_authentication_required>true</no_authentication_required>
<username_password_required>true</username_password_required>
<http_username>string</http_username>
<http_password>string</http_password>
updateDistributionPointById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/distributionpoints/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/distributionpoints/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/distributionpoints/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/distributionpoints/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/distributionpoints/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/distributionpoints/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/distributionpoints/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /distributionpoints/id/{id}
Updates an existing distribution point by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createDistributionPointById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/distributionpoints/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/distributionpoints/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/distributionpoints/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"ip_address": "string",
"is_master": true,
"failover_point": "string",
"failover_point_url": "string",
"enable_load_balancing": true,
"local_path": "string",
"ssh_username": "string",
"password": "string",
"connection_type": "SMB",
"share_name": "string",
"workgroup_or_domain": "string",
"share_port": 0,
"read_only_username": "string",
"read_only_password": "string",
"read_write_username": "string",
"read_write_password": "string",
"http_downloads_enabled": true,
"http_url": "string",
"context": "string",
"protocol": "string",
"port": 0,
"no_authentication_required": true,
"username_password_required": true,
"http_username": "string",
"http_password": "string"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/distributionpoints/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/distributionpoints/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/distributionpoints/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/distributionpoints/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /distributionpoints/id/{id}
Creates a new distribution point by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | distribution_point | true | Distribution point name |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<ip_address>string</ip_address>
<is_master>true</is_master>
<failover_point>string</failover_point>
<failover_point_url>string</failover_point_url>
<enable_load_balancing>true</enable_load_balancing>
<local_path>string</local_path>
<ssh_username>string</ssh_username>
<password>string</password>
<connection_type>SMB</connection_type>
<share_name>string</share_name>
<workgroup_or_domain>string</workgroup_or_domain>
<share_port>0</share_port>
<read_only_username>string</read_only_username>
<read_only_password>string</read_only_password>
<read_write_username>string</read_write_username>
<read_write_password>string</read_write_password>
<http_downloads_enabled>true</http_downloads_enabled>
<http_url>string</http_url>
<context>string</context>
<protocol>string</protocol>
<port>0</port>
<no_authentication_required>true</no_authentication_required>
<username_password_required>true</username_password_required>
<http_username>string</http_username>
<http_password>string</http_password>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteDistributionPointById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/distributionpoints/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/distributionpoints/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/distributionpoints/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/distributionpoints/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/distributionpoints/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/distributionpoints/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/distributionpoints/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /distributionpoints/id/{id}
Deletes a distribution point by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findDistributionPointsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/distributionpoints/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/distributionpoints/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/distributionpoints/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/distributionpoints/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/distributionpoints/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/distributionpoints/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/distributionpoints/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /distributionpoints/name/{name}
Finds distribution points by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<ip_address>string</ip_address>
<is_master>true</is_master>
<failover_point>string</failover_point>
<failover_point_url>string</failover_point_url>
<enable_load_balancing>true</enable_load_balancing>
<local_path>string</local_path>
<ssh_username>string</ssh_username>
<password>string</password>
<connection_type>SMB</connection_type>
<share_name>string</share_name>
<workgroup_or_domain>string</workgroup_or_domain>
<share_port>0</share_port>
<read_only_username>string</read_only_username>
<read_only_password>string</read_only_password>
<read_write_username>string</read_write_username>
<read_write_password>string</read_write_password>
<http_downloads_enabled>true</http_downloads_enabled>
<http_url>string</http_url>
<context>string</context>
<protocol>string</protocol>
<port>0</port>
<no_authentication_required>true</no_authentication_required>
<username_password_required>true</username_password_required>
<http_username>string</http_username>
<http_password>string</http_password>
updateDistributionPointByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/distributionpoints/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/distributionpoints/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/distributionpoints/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/distributionpoints/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/distributionpoints/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/distributionpoints/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/distributionpoints/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /distributionpoints/name/{name}
Updates an existing distribution point by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteDistributionPointByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/distributionpoints/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/distributionpoints/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/distributionpoints/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/distributionpoints/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/distributionpoints/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/distributionpoints/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/distributionpoints/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /distributionpoints/name/{name}
Deletes a distribution point by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findDockItems
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/dockitems \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/dockitems HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/dockitems',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/dockitems',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/dockitems', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/dockitems', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/dockitems");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /dockitems
Finds all dock items
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findDockItemsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/dockitems/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/dockitems/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/dockitems/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/dockitems/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/dockitems/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/dockitems/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/dockitems/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /dockitems/id/{id}
Finds dock items by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<type>App</type>
<path>file://localhost/Applications/Safari.app/</path>
<contents>string</contents>
updateDockItemById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/dockitems/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/dockitems/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/dockitems/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/dockitems/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/dockitems/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/dockitems/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/dockitems/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /dockitems/id/{id}
Updates an existing dock item by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createDockItemById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/dockitems/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/dockitems/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/dockitems/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"type": "App",
"path": "file://localhost/Applications/Safari.app/",
"contents": "string"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/dockitems/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/dockitems/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/dockitems/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/dockitems/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /dockitems/id/{id}
Creates a new dock item by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | dock_item | true | Dock item name |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<type>App</type>
<path>file://localhost/Applications/Safari.app/</path>
<contents>string</contents>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteDockItemById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/dockitems/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/dockitems/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/dockitems/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/dockitems/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/dockitems/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/dockitems/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/dockitems/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /dockitems/id/{id}
Deletes a dock item by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findDockItemsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/dockitems/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/dockitems/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/dockitems/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/dockitems/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/dockitems/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/dockitems/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/dockitems/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /dockitems/name/{name}
Finds dock items by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<type>App</type>
<path>file://localhost/Applications/Safari.app/</path>
<contents>string</contents>
updateDockItemByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/dockitems/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/dockitems/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/dockitems/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/dockitems/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/dockitems/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/dockitems/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/dockitems/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /dockitems/name/{name}
Updates an existing dock item by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteDockItemByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/dockitems/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/dockitems/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/dockitems/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/dockitems/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/dockitems/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/dockitems/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/dockitems/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /dockitems/name/{name}
Deletes a dock item by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findEBooks
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/ebooks \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/ebooks HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ebooks',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ebooks',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/ebooks', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/ebooks', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ebooks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /ebooks
Finds all ebooks
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<ebook>
<id>0</id>
<name>string</name>
</ebook>
findEBooksById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/ebooks/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/ebooks/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ebooks/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ebooks/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/ebooks/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/ebooks/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ebooks/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /ebooks/id/{id}
Finds ebooks by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<author>string</author>
<version>string</version>
<free>true</free>
<url>string</url>
<deployment_type>Make Available in Self Service</deployment_type>
<file_type>PDF</file_type>
<deploy_as_managed>true</deploy_as_managed>
<category>
<id>0</id>
<name>string</name>
</category>
<self_service_icon>string</self_service_icon>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
<scope>
<all_computers>true</all_computers>
<all_mobile_devices>true</all_mobile_devices>
<all_jss_users>true</all_jss_users>
<computers>
<computer>
<id>0</id>
<name>string</name>
<udid>string</udid>
</computer>
</computers>
<computer_groups/>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
<udid>string</udid>
<wifi_mac_address>string</wifi_mac_address>
</mobile_device>
</mobile_devices>
<mobile_device_groups/>
<buildings/>
<departments/>
<jss_users/>
<jss_user_groups/>
<classes/>
<limitations>
<network_segments/>
<users/>
<user_groups/>
</limitations>
<exclusions>
<computers>
<computer>
<id>0</id>
<name>string</name>
<udid>string</udid>
</computer>
</computers>
<computer_groups/>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
<udid>string</udid>
<wifi_mac_address>string</wifi_mac_address>
</mobile_device>
</mobile_devices>
<mobile_device_groups/>
<buildings/>
<departments/>
<jss_users/>
<jss_user_groups/>
<users>
<user>
<name>string</name>
</user>
</users>
<user_groups/>
<network_segments>
<network_segment>
<id>0</id>
<uid>string</uid>
<name>string</name>
</network_segment>
</network_segments>
</exclusions>
</scope>
<self_service>
<install_button_text>string</install_button_text>
<self_service_description>string</self_service_description>
<force_users_to_view_description>true</force_users_to_view_description>
<self_service_icon>string</self_service_icon>
<feature_on_main_page>true</feature_on_main_page>
<self_service_categories>
<category>
<id>0</id>
<name>string</name>
<display_in>true</display_in>
<feature_in>true</feature_in>
</category>
</self_service_categories>
<notification>true</notification>
<notification_subject>string</notification_subject>
<notification_message>string</notification_message>
</self_service>
updateEBookById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/ebooks/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/ebooks/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ebooks/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ebooks/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/ebooks/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/ebooks/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ebooks/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /ebooks/id/{id}
Updates an existing ebook by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createEBookById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/ebooks/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/ebooks/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ebooks/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"id": 0,
"name": "string",
"author": "string",
"version": "string",
"free": true,
"url": "string",
"deployment_type": "Make Available in Self Service",
"file_type": "PDF",
"deploy_as_managed": true,
"category": {
"id": 0,
"name": "string"
},
"self_service_icon": "string",
"site": {
"id": 0,
"name": "string"
}
},
"scope": {
"all_computers": true,
"all_mobile_devices": true,
"all_jss_users": true,
"computers": {
"computer": {
"id": 0,
"name": "string",
"udid": "string"
}
},
"computer_groups": {},
"mobile_devices": {
"mobile_device": {
"id": 0,
"name": "string",
"udid": "string",
"wifi_mac_address": "string"
}
},
"mobile_device_groups": {},
"buildings": {},
"departments": {},
"jss_users": {},
"jss_user_groups": {},
"classes": {},
"limitations": {
"network_segments": {},
"users": {},
"user_groups": {}
},
"exclusions": {
"computers": {
"computer": {
"id": 0,
"name": "string",
"udid": "string"
}
},
"computer_groups": {},
"mobile_devices": {
"mobile_device": {
"id": 0,
"name": "string",
"udid": "string",
"wifi_mac_address": "string"
}
},
"mobile_device_groups": {},
"buildings": {},
"departments": {},
"jss_users": {},
"jss_user_groups": {},
"users": {
"user": {
"name": "string"
}
},
"user_groups": {},
"network_segments": {
"network_segment": {
"id": 0,
"uid": "string",
"name": "string"
}
}
}
},
"self_service": {
"install_button_text": "string",
"self_service_description": "string",
"force_users_to_view_description": true,
"self_service_icon": "string",
"feature_on_main_page": true,
"self_service_categories": {
"category": {
"id": 0,
"name": "string",
"display_in": true,
"feature_in": true
}
},
"notification": true,
"notification_subject": "string",
"notification_message": "string"
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ebooks/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/ebooks/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/ebooks/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ebooks/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /ebooks/id/{id}
Creates a new ebook by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | ebook | true | Ebook name |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<author>string</author>
<version>string</version>
<free>true</free>
<url>string</url>
<deployment_type>Make Available in Self Service</deployment_type>
<file_type>PDF</file_type>
<deploy_as_managed>true</deploy_as_managed>
<category>
<id>0</id>
<name>string</name>
</category>
<self_service_icon>string</self_service_icon>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
<scope>
<all_computers>true</all_computers>
<all_mobile_devices>true</all_mobile_devices>
<all_jss_users>true</all_jss_users>
<computers>
<computer>
<id>0</id>
<name>string</name>
<udid>string</udid>
</computer>
</computers>
<computer_groups/>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
<udid>string</udid>
<wifi_mac_address>string</wifi_mac_address>
</mobile_device>
</mobile_devices>
<mobile_device_groups/>
<buildings/>
<departments/>
<jss_users/>
<jss_user_groups/>
<classes/>
<limitations>
<network_segments/>
<users/>
<user_groups/>
</limitations>
<exclusions>
<computers>
<computer>
<id>0</id>
<name>string</name>
<udid>string</udid>
</computer>
</computers>
<computer_groups/>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
<udid>string</udid>
<wifi_mac_address>string</wifi_mac_address>
</mobile_device>
</mobile_devices>
<mobile_device_groups/>
<buildings/>
<departments/>
<jss_users/>
<jss_user_groups/>
<users>
<user>
<name>string</name>
</user>
</users>
<user_groups/>
<network_segments>
<network_segment>
<id>0</id>
<uid>string</uid>
<name>string</name>
</network_segment>
</network_segments>
</exclusions>
</scope>
<self_service>
<install_button_text>string</install_button_text>
<self_service_description>string</self_service_description>
<force_users_to_view_description>true</force_users_to_view_description>
<self_service_icon>string</self_service_icon>
<feature_on_main_page>true</feature_on_main_page>
<self_service_categories>
<category>
<id>0</id>
<name>string</name>
<display_in>true</display_in>
<feature_in>true</feature_in>
</category>
</self_service_categories>
<notification>true</notification>
<notification_subject>string</notification_subject>
<notification_message>string</notification_message>
</self_service>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteEBookById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/ebooks/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/ebooks/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ebooks/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ebooks/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/ebooks/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/ebooks/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ebooks/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /ebooks/id/{id}
Deletes an ebook by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findEBooksByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/ebooks/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/ebooks/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ebooks/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ebooks/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/ebooks/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/ebooks/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ebooks/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /ebooks/name/{name}
Finds ebooks by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<author>string</author>
<version>string</version>
<free>true</free>
<url>string</url>
<deployment_type>Make Available in Self Service</deployment_type>
<file_type>PDF</file_type>
<deploy_as_managed>true</deploy_as_managed>
<category>
<id>0</id>
<name>string</name>
</category>
<self_service_icon>string</self_service_icon>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
<scope>
<all_computers>true</all_computers>
<all_mobile_devices>true</all_mobile_devices>
<all_jss_users>true</all_jss_users>
<computers>
<computer>
<id>0</id>
<name>string</name>
<udid>string</udid>
</computer>
</computers>
<computer_groups/>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
<udid>string</udid>
<wifi_mac_address>string</wifi_mac_address>
</mobile_device>
</mobile_devices>
<mobile_device_groups/>
<buildings/>
<departments/>
<jss_users/>
<jss_user_groups/>
<classes/>
<limitations>
<network_segments/>
<users/>
<user_groups/>
</limitations>
<exclusions>
<computers>
<computer>
<id>0</id>
<name>string</name>
<udid>string</udid>
</computer>
</computers>
<computer_groups/>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
<udid>string</udid>
<wifi_mac_address>string</wifi_mac_address>
</mobile_device>
</mobile_devices>
<mobile_device_groups/>
<buildings/>
<departments/>
<jss_users/>
<jss_user_groups/>
<users>
<user>
<name>string</name>
</user>
</users>
<user_groups/>
<network_segments>
<network_segment>
<id>0</id>
<uid>string</uid>
<name>string</name>
</network_segment>
</network_segments>
</exclusions>
</scope>
<self_service>
<install_button_text>string</install_button_text>
<self_service_description>string</self_service_description>
<force_users_to_view_description>true</force_users_to_view_description>
<self_service_icon>string</self_service_icon>
<feature_on_main_page>true</feature_on_main_page>
<self_service_categories>
<category>
<id>0</id>
<name>string</name>
<display_in>true</display_in>
<feature_in>true</feature_in>
</category>
</self_service_categories>
<notification>true</notification>
<notification_subject>string</notification_subject>
<notification_message>string</notification_message>
</self_service>
updateEBookByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/ebooks/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/ebooks/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ebooks/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ebooks/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/ebooks/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/ebooks/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ebooks/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /ebooks/name/{name}
Updates an existing ebook by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteEBookByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/ebooks/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/ebooks/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ebooks/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ebooks/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/ebooks/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/ebooks/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ebooks/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /ebooks/name/{name}
Deletes an ebook by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findEbookssByIdSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/ebooks/id/{id}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/ebooks/id/{id}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ebooks/id/{id}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ebooks/id/{id}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/ebooks/id/{id}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/ebooks/id/{id}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ebooks/id/{id}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /ebooks/id/{id}/subset/{subset}
Display subsets of information for an ebook
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | ID to filter by |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | General |
| subset | Scope |
| subset | SelfService |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
uploadFiles
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/fileuploads/{resource}/{idType}/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/fileuploads/{resource}/{idType}/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/fileuploads/{resource}/{idType}/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/fileuploads/{resource}/{idType}/{id}',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/fileuploads/{resource}/{idType}/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/fileuploads/{resource}/{idType}/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/fileuploads/{resource}/{idType}/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /fileuploads/{resource}/{idType}/{id}
Creates file attachments in the JSS
Here is a sample command curl -k -u user:password https://my.jss:8443/JSSResource/fileuploads/computers/id/2 -F name=@/Users/admin/Documents/Sample.doc -X POST
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| resource | path | string | true | Resource to attach the file to |
| idType | path | string | true | Name is supported for all but the peripherals resource |
| id | path | string | true | No description |
Enumerated Values
| Parameter | Value |
|---|---|
| resource | computers |
| resource | mobiledevices |
| resource | enrollmentprofiles |
| resource | printers |
| resource | peripherals |
| resource | policies |
| resource | ebooks |
| resource | mobiledeviceapplicationsicon |
| resource | mobiledeviceapplicationsipa |
| resource | diskencryptionconfigurations |
| idType | id |
| idType | name |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
findGSXConnection
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/gsxconnection \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/gsxconnection HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/gsxconnection',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/gsxconnection',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/gsxconnection', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/gsxconnection', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/gsxconnection");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /gsxconnection
Finds the JSS GSX connection information
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<enabled>true</enabled>
<username>string</username>
<account_number>0</account_number>
<region>Americas</region>
<uri>string</uri>
updateGSXConnection
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/gsxconnection \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/gsxconnection HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/gsxconnection',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/gsxconnection',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/gsxconnection', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/gsxconnection', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/gsxconnection");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /gsxconnection
Updates the JSS GSX connection information
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
findHealthcareListener
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/healthcarelistener \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/healthcarelistener HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/healthcarelistener',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/healthcarelistener',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/healthcarelistener', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/healthcarelistener', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/healthcarelistener");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /healthcarelistener
Find all Healthcare Listeners
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findHealthcareListenersById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/healthcarelistener/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/healthcarelistener/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/healthcarelistener/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/healthcarelistener/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/healthcarelistener/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/healthcarelistener/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/healthcarelistener/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /healthcarelistener/id/{id}
Finds healthcare listener by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<infratructure_manager_id>0</infratructure_manager_id>
<enabled>true</enabled>
<name>string</name>
<single_ips>string</single_ips>
<range_ips>string</range_ips>
<port>0</port>
<commands>string</commands>
<device_inventory_field>string</device_inventory_field>
<notification_enabled>true</notification_enabled>
<notification_emails>string</notification_emails>
updateHealthCareListenerById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/healthcarelistener/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/healthcarelistener/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/healthcarelistener/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/healthcarelistener/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/healthcarelistener/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/healthcarelistener/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/healthcarelistener/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /healthcarelistener/id/{id}
Updates an existing healthcare listener by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
findIBeacons
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/ibeacons \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/ibeacons HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ibeacons',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ibeacons',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/ibeacons', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/ibeacons', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ibeacons");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /ibeacons
Finds all iBeacon regions
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findIBeaconsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/ibeacons/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/ibeacons/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ibeacons/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ibeacons/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/ibeacons/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/ibeacons/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ibeacons/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /ibeacons/id/{id}
Finds iBeacon regions by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<uuid>string</uuid>
<major>string</major>
<minor>string</minor>
updateIBeaconById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/ibeacons/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/ibeacons/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ibeacons/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ibeacons/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/ibeacons/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/ibeacons/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ibeacons/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /ibeacons/id/{id}
Updates an existing iBeacon region by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createIBeaconById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/ibeacons/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/ibeacons/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ibeacons/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"uuid": "string",
"major": "string",
"minor": "string"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ibeacons/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/ibeacons/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/ibeacons/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ibeacons/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /ibeacons/id/{id}
Creates a new iBeacon region by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | ibeacon | true | Name of the iBeacon |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<uuid>string</uuid>
<major>string</major>
<minor>string</minor>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteIBeaconById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/ibeacons/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/ibeacons/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ibeacons/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ibeacons/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/ibeacons/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/ibeacons/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ibeacons/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /ibeacons/id/{id}
Deletes an iBeacon region by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findIBeaconsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/ibeacons/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/ibeacons/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ibeacons/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ibeacons/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/ibeacons/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/ibeacons/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ibeacons/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /ibeacons/name/{name}
Finds iBeacon regions by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<uuid>string</uuid>
<major>string</major>
<minor>string</minor>
updateIBeaconByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/ibeacons/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/ibeacons/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ibeacons/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ibeacons/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/ibeacons/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/ibeacons/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ibeacons/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /ibeacons/name/{name}
Updates an existing iBeacon region by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteIBeaconByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/ibeacons/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/ibeacons/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ibeacons/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ibeacons/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/ibeacons/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/ibeacons/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ibeacons/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /ibeacons/name/{name}
Deletes an iBeacon region by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findInfrastructureManager
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/infrastructuremanager \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/infrastructuremanager HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/infrastructuremanager',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/infrastructuremanager',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/infrastructuremanager', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/infrastructuremanager', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/infrastructuremanager");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /infrastructuremanager
Find all Infrastructure Managers
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findInfrastructureManagerById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/infrastructuremanager/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/infrastructuremanager/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/infrastructuremanager/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/infrastructuremanager/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/infrastructuremanager/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/infrastructuremanager/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/infrastructuremanager/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /infrastructuremanager/id/{id}
Finds infrastructure manager by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<uuid>string</uuid>
<name>string</name>
<hostname>string</hostname>
<last_check_in>string</last_check_in>
<last_reported_ip>string</last_reported_ip>
<operating_system>string</operating_system>
<operating_system_version>string</operating_system_version>
<recurring_check_in_frequency>0</recurring_check_in_frequency>
updateInfrastructureManagerById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/infrastructuremanager/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/infrastructuremanager/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/infrastructuremanager/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/infrastructuremanager/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/infrastructuremanager/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/infrastructuremanager/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/infrastructuremanager/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /infrastructuremanager/id/{id}
Updates an existing infrastructure manager by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
findLDAPServers
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/ldapservers \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/ldapservers HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ldapservers',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ldapservers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/ldapservers', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/ldapservers', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ldapservers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /ldapservers
Finds all LDAP servers
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findLDAPServersById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/ldapservers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/ldapservers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ldapservers/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ldapservers/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/ldapservers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/ldapservers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ldapservers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /ldapservers/id/{id}
Finds LDAP servers by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<connection>
<id>0</id>
<name>string</name>
<hostname>string</hostname>
<server_type>Active Directory</server_type>
<port>0</port>
<use_ssl>true</use_ssl>
<authentication_type>simple</authentication_type>
<open_close_timeout>0</open_close_timeout>
<search_timeout>0</search_timeout>
<referral_response>ignore</referral_response>
<use_wildcards>true</use_wildcards>
<connection_is_used_for>string</connection_is_used_for>
</connection>
updateLDAPServerById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/ldapservers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/ldapservers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ldapservers/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ldapservers/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/ldapservers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/ldapservers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ldapservers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /ldapservers/id/{id}
Updates an existing LDAP server by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createLDAPServerById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/ldapservers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/ldapservers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ldapservers/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"connection": {
"id": 0,
"name": "string",
"hostname": "string",
"server_type": "Active Directory",
"port": 0,
"use_ssl": true,
"authentication_type": "simple",
"open_close_timeout": 0,
"search_timeout": 0,
"referral_response": "ignore",
"use_wildcards": true,
"connection_is_used_for": "string"
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ldapservers/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/ldapservers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/ldapservers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ldapservers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /ldapservers/id/{id}
Creates a new LDAP server by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | ldap_server | true | LDAP server name |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<connection>
<id>0</id>
<name>string</name>
<hostname>string</hostname>
<server_type>Active Directory</server_type>
<port>0</port>
<use_ssl>true</use_ssl>
<authentication_type>simple</authentication_type>
<open_close_timeout>0</open_close_timeout>
<search_timeout>0</search_timeout>
<referral_response>ignore</referral_response>
<use_wildcards>true</use_wildcards>
<connection_is_used_for>string</connection_is_used_for>
</connection>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteLDAPServerById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/ldapservers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/ldapservers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ldapservers/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ldapservers/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/ldapservers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/ldapservers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ldapservers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /ldapservers/id/{id}
Deletes an LDAP server by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findLDAPServersByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/ldapservers/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/ldapservers/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ldapservers/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ldapservers/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/ldapservers/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/ldapservers/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ldapservers/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /ldapservers/name/{name}
Finds LDAP servers by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
updateLDAPServerByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/ldapservers/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/ldapservers/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ldapservers/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ldapservers/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/ldapservers/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/ldapservers/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ldapservers/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /ldapservers/name/{name}
Updates an existing LDAP server by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteLDAPServerByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/ldapservers/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/ldapservers/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ldapservers/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ldapservers/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/ldapservers/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/ldapservers/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ldapservers/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /ldapservers/name/{name}
Deletes an LDAP server by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findLDAPServerUser
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/ldapservers/id/{id}/user/{user} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/ldapservers/id/{id}/user/{user} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ldapservers/id/{id}/user/{user}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ldapservers/id/{id}/user/{user}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/ldapservers/id/{id}/user/{user}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/ldapservers/id/{id}/user/{user}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ldapservers/id/{id}/user/{user}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /ldapservers/id/{id}/user/{user}
Display information for matching users for an LDAP server
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | Server ID to filter by |
| user | path | string | true | User to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findLDAPServerGroup
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/ldapservers/id/{id}/group/{group} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/ldapservers/id/{id}/group/{group} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ldapservers/id/{id}/group/{group}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ldapservers/id/{id}/group/{group}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/ldapservers/id/{id}/group/{group}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/ldapservers/id/{id}/group/{group}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ldapservers/id/{id}/group/{group}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /ldapservers/id/{id}/group/{group}
Display information for matching groups for an LDAP server
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | Server ID to filter by |
| group | path | string | true | Group to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findLDAPServerGroupUser
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/ldapservers/id/{id}/group/{group}/user/{user} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/ldapservers/id/{id}/group/{group}/user/{user} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/ldapservers/id/{id}/group/{group}/user/{user}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/ldapservers/id/{id}/group/{group}/user/{user}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/ldapservers/id/{id}/group/{group}/user/{user}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/ldapservers/id/{id}/group/{group}/user/{user}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/ldapservers/id/{id}/group/{group}/user/{user}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /ldapservers/id/{id}/group/{group}/user/{user}
Display information about user membership in a group for an LDAP server
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | Server ID to filter by |
| group | path | string | true | Group to filter by |
| user | path | string | true | User to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findLicensedSoftware
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/licensedsoftware \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/licensedsoftware HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/licensedsoftware',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/licensedsoftware',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/licensedsoftware', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/licensedsoftware', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/licensedsoftware");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /licensedsoftware
Finds all licensed software
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<licensed_software>
<licensed_software>
<id>0</id>
<name>string</name>
</licensed_software>
</licensed_software>
findLicensedSoftwareById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/licensedsoftware/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/licensedsoftware/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/licensedsoftware/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/licensedsoftware/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/licensedsoftware/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/licensedsoftware/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/licensedsoftware/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /licensedsoftware/id/{id}
Finds licensed software by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<publisher>string</publisher>
<platform>string</platform>
<send_email_on_violation>true</send_email_on_violation>
<remove_titles_from_inventory_reports>true</remove_titles_from_inventory_reports>
<exclude_titles_purchased_from_app_store>true</exclude_titles_purchased_from_app_store>
</general>
updateLicensedSoftwareById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/licensedsoftware/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/licensedsoftware/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/licensedsoftware/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/licensedsoftware/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/licensedsoftware/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/licensedsoftware/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/licensedsoftware/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /licensedsoftware/id/{id}
Updates an existing computer command by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createLicensedSoftwareById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/licensedsoftware/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/licensedsoftware/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/licensedsoftware/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"id": 0,
"name": "string",
"publisher": "string",
"platform": "string",
"send_email_on_violation": true,
"remove_titles_from_inventory_reports": true,
"exclude_titles_purchased_from_app_store": true
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/licensedsoftware/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/licensedsoftware/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/licensedsoftware/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/licensedsoftware/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /licensedsoftware/id/{id}
Creates a new computer command by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | licensed_software | true | Licensed software name |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<publisher>string</publisher>
<platform>string</platform>
<send_email_on_violation>true</send_email_on_violation>
<remove_titles_from_inventory_reports>true</remove_titles_from_inventory_reports>
<exclude_titles_purchased_from_app_store>true</exclude_titles_purchased_from_app_store>
</general>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteLicensedSoftwareById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/licensedsoftware/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/licensedsoftware/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/licensedsoftware/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/licensedsoftware/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/licensedsoftware/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/licensedsoftware/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/licensedsoftware/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /licensedsoftware/id/{id}
Deletes a computer command by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findLicensedSoftwareByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/licensedsoftware/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/licensedsoftware/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/licensedsoftware/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/licensedsoftware/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/licensedsoftware/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/licensedsoftware/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/licensedsoftware/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /licensedsoftware/name/{name}
Finds licensed software by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<publisher>string</publisher>
<platform>string</platform>
<send_email_on_violation>true</send_email_on_violation>
<remove_titles_from_inventory_reports>true</remove_titles_from_inventory_reports>
<exclude_titles_purchased_from_app_store>true</exclude_titles_purchased_from_app_store>
</general>
updateLicensedSoftwareByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/licensedsoftware/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/licensedsoftware/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/licensedsoftware/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/licensedsoftware/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/licensedsoftware/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/licensedsoftware/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/licensedsoftware/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /licensedsoftware/name/{name}
Updates an existing computer command by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteLicensedSoftwareByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/licensedsoftware/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/licensedsoftware/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/licensedsoftware/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/licensedsoftware/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/licensedsoftware/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/licensedsoftware/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/licensedsoftware/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /licensedsoftware/name/{name}
Deletes a computer command by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
logFlush
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/logflush \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/logflush HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/logflush',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"log": "policy",
"log_id": 0,
"interval": "Zero Days",
"computers": {
"computer": {
"id": 0
}
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/logflush',
{
method: 'DELETE',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/logflush', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/logflush', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/logflush");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /logflush
Flushes a log specified in an XML file
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | logflush | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<log>policy</log>
<log_id>0</log_id>
<interval>Zero Days</interval>
<computers>
<computer>
<id>0</id>
</computer>
</computers>
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
createLogFlushForInterval
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/logflush/{log}/interval/{interval} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/logflush/{log}/interval/{interval} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/logflush/{log}/interval/{interval}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/logflush/{log}/interval/{interval}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/logflush/{log}/interval/{interval}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/logflush/{log}/interval/{interval}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/logflush/{log}/interval/{interval}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /logflush/{log}/interval/{interval}
Flushes all logs for a given interval
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| interval | path | string | true | Supported values are a combination of [Zero, One, Two, Three, Six] and [Days, Weeks, Months, Years] |
| log | path | string | true | At this time, only ‘policy’ logs are supported |
Enumerated Values
| Parameter | Value |
|---|---|
| log | policy |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
createLogFlushWithIdAndInterval
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/logflush/{log}/id/{id}/interval/{interval} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/logflush/{log}/id/{id}/interval/{interval} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/logflush/{log}/id/{id}/interval/{interval}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/logflush/{log}/id/{id}/interval/{interval}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/logflush/{log}/id/{id}/interval/{interval}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/logflush/{log}/id/{id}/interval/{interval}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/logflush/{log}/id/{id}/interval/{interval}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /logflush/{log}/id/{id}/interval/{interval}
Flushes a single log for a given interval
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | ID of policy whose log will be flushed |
| log | path | string | true | At this time, only ‘policy’ logs are supported |
| interval | path | string | true | Supported values are a combination of [Zero, One, Two, Three, Six] and [Days, Weeks, Months, Years] |
Enumerated Values
| Parameter | Value |
|---|---|
| log | policy |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMacapps
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/macapplications \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/macapplications HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/macapplications',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/macapplications',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/macapplications', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/macapplications', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/macapplications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /macapplications
Finds all mac applications
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<mac_application>
<id>0</id>
<name>string</name>
</mac_application>
findMacappsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/macapplications/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/macapplications/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/macapplications/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/macapplications/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/macapplications/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/macapplications/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/macapplications/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /macapplications/id/{id}
Finds mac applications by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<version>string</version>
<is_free>true</is_free>
<bundle_id>string</bundle_id>
<url>string</url>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
updateMacappById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/macapplications/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/macapplications/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/macapplications/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/macapplications/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/macapplications/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/macapplications/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/macapplications/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /macapplications/id/{id}
Updates an existing mac application by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createMacappById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/macapplications/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/macapplications/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/macapplications/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"id": 0,
"name": "string",
"version": "string",
"is_free": true,
"bundle_id": "string",
"url": "string",
"category": {
"id": 0,
"name": "Category name",
"priority": 9
},
"site": {
"id": 0,
"name": "string"
}
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/macapplications/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/macapplications/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/macapplications/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/macapplications/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /macapplications/id/{id}
Creates a new mac application by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | mac_application | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<version>string</version>
<is_free>true</is_free>
<bundle_id>string</bundle_id>
<url>string</url>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMacappById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/macapplications/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/macapplications/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/macapplications/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/macapplications/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/macapplications/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/macapplications/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/macapplications/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /macapplications/id/{id}
Deletes a mac application by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMacappsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/macapplications/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/macapplications/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/macapplications/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/macapplications/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/macapplications/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/macapplications/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/macapplications/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /macapplications/name/{name}
Finds mac applications by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<version>string</version>
<is_free>true</is_free>
<bundle_id>string</bundle_id>
<url>string</url>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
updateMacappByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/macapplications/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/macapplications/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/macapplications/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/macapplications/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/macapplications/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/macapplications/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/macapplications/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /macapplications/name/{name}
Updates an existing mac application by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMacappByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/macapplications/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/macapplications/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/macapplications/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/macapplications/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/macapplications/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/macapplications/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/macapplications/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /macapplications/name/{name}
Deletes a mac application by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMacappsByIdSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/macapplications/id/{id}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/macapplications/id/{id}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/macapplications/id/{id}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/macapplications/id/{id}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/macapplications/id/{id}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/macapplications/id/{id}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/macapplications/id/{id}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /macapplications/id/{id}/subset/{subset}
Display subsets of information for a mac application
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID to filter by |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | General |
| subset | Scope |
| subset | SelfService |
| subset | VPPCodes |
| subset | VPP |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findManagedPreferenceProfiles
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/managedpreferenceprofiles \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/managedpreferenceprofiles HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/managedpreferenceprofiles',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/managedpreferenceprofiles',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/managedpreferenceprofiles', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/managedpreferenceprofiles', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/managedpreferenceprofiles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /managedpreferenceprofiles
Finds all managed preference profiles
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<managed_preference_profile>
<id>0</id>
<name>string</name>
</managed_preference_profile>
findManagedPreferenceProfilesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/managedpreferenceprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/managedpreferenceprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/managedpreferenceprofiles/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/managedpreferenceprofiles/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/managedpreferenceprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/managedpreferenceprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/managedpreferenceprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /managedpreferenceprofiles/id/{id}
Finds managed preference profiles by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<enabled>true</enabled>
<plist>string</plist>
</general>
updateManagedPreferenceProfilesById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/managedpreferenceprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/managedpreferenceprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/managedpreferenceprofiles/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/managedpreferenceprofiles/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/managedpreferenceprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/managedpreferenceprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/managedpreferenceprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /managedpreferenceprofiles/id/{id}
Updates an existing managed preference profiles by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createManagedPreferenceProfileById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/managedpreferenceprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/managedpreferenceprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/managedpreferenceprofiles/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"id": 0,
"name": "string",
"enabled": true,
"plist": "string"
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/managedpreferenceprofiles/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/managedpreferenceprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/managedpreferenceprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/managedpreferenceprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /managedpreferenceprofiles/id/{id}
Creates a new managed preference profile by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | managed_preference_profile | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<enabled>true</enabled>
<plist>string</plist>
</general>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteManagedPreferenceProfilesById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/managedpreferenceprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/managedpreferenceprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/managedpreferenceprofiles/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/managedpreferenceprofiles/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/managedpreferenceprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/managedpreferenceprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/managedpreferenceprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /managedpreferenceprofiles/id/{id}
Deletes a managed preference profiles by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findManagedPreferenceProfilesByIdSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/managedpreferenceprofiles/id/{id}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/managedpreferenceprofiles/id/{id}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/managedpreferenceprofiles/id/{id}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/managedpreferenceprofiles/id/{id}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/managedpreferenceprofiles/id/{id}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/managedpreferenceprofiles/id/{id}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/managedpreferenceprofiles/id/{id}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /managedpreferenceprofiles/id/{id}/subset/{subset}
Display subsets of information for a managed preference profile
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID to filter by |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | General |
| subset | Scope |
| subset | Settings |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findManagedPreferenceProfilesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/managedpreferenceprofiles/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/managedpreferenceprofiles/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/managedpreferenceprofiles/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/managedpreferenceprofiles/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/managedpreferenceprofiles/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/managedpreferenceprofiles/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/managedpreferenceprofiles/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /managedpreferenceprofiles/name/{name}
Finds managed preference profiles by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<enabled>true</enabled>
<plist>string</plist>
</general>
updateManagedPreferenceProfilesByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/managedpreferenceprofiles/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/managedpreferenceprofiles/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/managedpreferenceprofiles/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/managedpreferenceprofiles/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/managedpreferenceprofiles/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/managedpreferenceprofiles/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/managedpreferenceprofiles/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /managedpreferenceprofiles/name/{name}
Updates an existing managed preference profiles by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteManagedPreferenceProfilesByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/managedpreferenceprofiles/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/managedpreferenceprofiles/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/managedpreferenceprofiles/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/managedpreferenceprofiles/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/managedpreferenceprofiles/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/managedpreferenceprofiles/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/managedpreferenceprofiles/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /managedpreferenceprofiles/name/{name}
Deletes a managed preference profiles by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDeviceApplications
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceapplications \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceapplications HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceapplications',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceapplications',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceapplications', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceapplications', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceapplications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceapplications
Finds all mobile device applications
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<mobile_device_application>
<id>0</id>
<name>string</name>
<display_name>string</display_name>
<bundle_id>string</bundle_id>
<version>string</version>
<internal_app>true</internal_app>
</mobile_device_application>
findMobileDeviceApplicationsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceapplications/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceapplications/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceapplications/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceapplications/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceapplications/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceapplications/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceapplications/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceapplications/id/{id}
Finds mobile device applications by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<display_name>string</display_name>
<description>string</description>
<bundle_id>string</bundle_id>
<version>string</version>
<internal_app>true</internal_app>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<icon>string</icon>
<mobile_device_provisioning_profile>0</mobile_device_provisioning_profile>
<itunes_store_url>string</itunes_store_url>
<make_available_after_install>true</make_available_after_install>
<itunes_country_region>string</itunes_country_region>
<itunes_sync_time>0</itunes_sync_time>
<deployment_type>Make Available in Self Service</deployment_type>
<deploy_automatically>true</deploy_automatically>
<deploy_as_managed_app>true</deploy_as_managed_app>
<remove_app_when_mdm_profile_is_removed>true</remove_app_when_mdm_profile_is_removed>
<prevent_backup_of_app_data>true</prevent_backup_of_app_data>
<keep_description_and_icon_up_to_date>true</keep_description_and_icon_up_to_date>
<free>true</free>
<take_over_management>true</take_over_management>
<host_externally>true</host_externally>
<external_url>string</external_url>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
updateMobileDeviceApplicationById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledeviceapplications/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledeviceapplications/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceapplications/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceapplications/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledeviceapplications/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledeviceapplications/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceapplications/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledeviceapplications/id/{id}
Updates an existing mobile device application by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createMobileDeviceApplicationById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/mobiledeviceapplications/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/mobiledeviceapplications/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceapplications/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"id": 0,
"name": "string",
"display_name": "string",
"description": "string",
"bundle_id": "string",
"version": "string",
"internal_app": true,
"category": {
"id": 0,
"name": "Category name",
"priority": 9
},
"icon": "string",
"mobile_device_provisioning_profile": 0,
"itunes_store_url": "string",
"make_available_after_install": true,
"itunes_country_region": "string",
"itunes_sync_time": 0,
"deployment_type": "Make Available in Self Service",
"deploy_automatically": true,
"deploy_as_managed_app": true,
"remove_app_when_mdm_profile_is_removed": true,
"prevent_backup_of_app_data": true,
"keep_description_and_icon_up_to_date": true,
"free": true,
"take_over_management": true,
"host_externally": true,
"external_url": "string",
"site": {
"id": 0,
"name": "string"
}
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceapplications/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/mobiledeviceapplications/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/mobiledeviceapplications/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceapplications/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /mobiledeviceapplications/id/{id}
Creates a new mobile device application by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | mobile_device_application | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<display_name>string</display_name>
<description>string</description>
<bundle_id>string</bundle_id>
<version>string</version>
<internal_app>true</internal_app>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<icon>string</icon>
<mobile_device_provisioning_profile>0</mobile_device_provisioning_profile>
<itunes_store_url>string</itunes_store_url>
<make_available_after_install>true</make_available_after_install>
<itunes_country_region>string</itunes_country_region>
<itunes_sync_time>0</itunes_sync_time>
<deployment_type>Make Available in Self Service</deployment_type>
<deploy_automatically>true</deploy_automatically>
<deploy_as_managed_app>true</deploy_as_managed_app>
<remove_app_when_mdm_profile_is_removed>true</remove_app_when_mdm_profile_is_removed>
<prevent_backup_of_app_data>true</prevent_backup_of_app_data>
<keep_description_and_icon_up_to_date>true</keep_description_and_icon_up_to_date>
<free>true</free>
<take_over_management>true</take_over_management>
<host_externally>true</host_externally>
<external_url>string</external_url>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobileDeviceApplicationById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledeviceapplications/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledeviceapplications/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceapplications/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceapplications/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledeviceapplications/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledeviceapplications/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceapplications/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledeviceapplications/id/{id}
Deletes a mobile device application by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDeviceApplicationsByBundleID
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceapplications/bundleid/{bundleid}
Finds mobile device applications by bundle ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| bundleid | path | string | true | Bundle ID to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<display_name>string</display_name>
<description>string</description>
<bundle_id>string</bundle_id>
<version>string</version>
<internal_app>true</internal_app>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<icon>string</icon>
<mobile_device_provisioning_profile>0</mobile_device_provisioning_profile>
<itunes_store_url>string</itunes_store_url>
<make_available_after_install>true</make_available_after_install>
<itunes_country_region>string</itunes_country_region>
<itunes_sync_time>0</itunes_sync_time>
<deployment_type>Make Available in Self Service</deployment_type>
<deploy_automatically>true</deploy_automatically>
<deploy_as_managed_app>true</deploy_as_managed_app>
<remove_app_when_mdm_profile_is_removed>true</remove_app_when_mdm_profile_is_removed>
<prevent_backup_of_app_data>true</prevent_backup_of_app_data>
<keep_description_and_icon_up_to_date>true</keep_description_and_icon_up_to_date>
<free>true</free>
<take_over_management>true</take_over_management>
<host_externally>true</host_externally>
<external_url>string</external_url>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
updateMobileDeviceApplicationByBundleID
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledeviceapplications/bundleid/{bundleid}
Updates an existing mobile device application by bundle ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| bundleid | path | string | true | Bundle ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobileDeviceApplicationByBundleID
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledeviceapplications/bundleid/{bundleid}
Deletes a mobile device application by bundle ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| bundleid | path | string | true | Bundle ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDeviceApplicationsByBundleIDandVersion
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceapplications/bundleid/{bundleid}/version/{version}
Finds mobile device applications by bundle ID and version
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| bundleid | path | string | true | Bundle ID to filter by |
| version | path | string | true | Version to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<display_name>string</display_name>
<description>string</description>
<bundle_id>string</bundle_id>
<version>string</version>
<internal_app>true</internal_app>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<icon>string</icon>
<mobile_device_provisioning_profile>0</mobile_device_provisioning_profile>
<itunes_store_url>string</itunes_store_url>
<make_available_after_install>true</make_available_after_install>
<itunes_country_region>string</itunes_country_region>
<itunes_sync_time>0</itunes_sync_time>
<deployment_type>Make Available in Self Service</deployment_type>
<deploy_automatically>true</deploy_automatically>
<deploy_as_managed_app>true</deploy_as_managed_app>
<remove_app_when_mdm_profile_is_removed>true</remove_app_when_mdm_profile_is_removed>
<prevent_backup_of_app_data>true</prevent_backup_of_app_data>
<keep_description_and_icon_up_to_date>true</keep_description_and_icon_up_to_date>
<free>true</free>
<take_over_management>true</take_over_management>
<host_externally>true</host_externally>
<external_url>string</external_url>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
updateMobileDeviceApplicationByBundleIDandVersion
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledeviceapplications/bundleid/{bundleid}/version/{version}
Updates an existing mobile device application by bundle ID and version
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| bundleid | path | string | true | Bundle ID value to filter by |
| version | path | string | true | Version to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobileDeviceApplicationByBundleIDandVersion
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceapplications/bundleid/{bundleid}/version/{version}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledeviceapplications/bundleid/{bundleid}/version/{version}
Deletes a mobile device application by bundle ID and version
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| bundleid | path | string | true | Bundle ID value to filter by |
| version | path | string | true | Version to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDeviceApplicationsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceapplications/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceapplications/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceapplications/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceapplications/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceapplications/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceapplications/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceapplications/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceapplications/name/{name}
Finds mobile device applications by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<display_name>string</display_name>
<description>string</description>
<bundle_id>string</bundle_id>
<version>string</version>
<internal_app>true</internal_app>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<icon>string</icon>
<mobile_device_provisioning_profile>0</mobile_device_provisioning_profile>
<itunes_store_url>string</itunes_store_url>
<make_available_after_install>true</make_available_after_install>
<itunes_country_region>string</itunes_country_region>
<itunes_sync_time>0</itunes_sync_time>
<deployment_type>Make Available in Self Service</deployment_type>
<deploy_automatically>true</deploy_automatically>
<deploy_as_managed_app>true</deploy_as_managed_app>
<remove_app_when_mdm_profile_is_removed>true</remove_app_when_mdm_profile_is_removed>
<prevent_backup_of_app_data>true</prevent_backup_of_app_data>
<keep_description_and_icon_up_to_date>true</keep_description_and_icon_up_to_date>
<free>true</free>
<take_over_management>true</take_over_management>
<host_externally>true</host_externally>
<external_url>string</external_url>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
updateMobileDeviceApplicationByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledeviceapplications/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledeviceapplications/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceapplications/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceapplications/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledeviceapplications/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledeviceapplications/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceapplications/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledeviceapplications/name/{name}
Updates an existing mobile device application by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobileDeviceApplicationByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledeviceapplications/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledeviceapplications/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceapplications/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceapplications/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledeviceapplications/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledeviceapplications/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceapplications/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledeviceapplications/name/{name}
Deletes a mobile device application by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDeviceAppsByIdSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceapplications/id/{id}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceapplications/id/{id}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceapplications/id/{id}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceapplications/id/{id}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceapplications/id/{id}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceapplications/id/{id}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceapplications/id/{id}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceapplications/id/{id}/subset/{subset}
Display subsets of information for a mobile device application
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID to filter by |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | General |
| subset | Scope |
| subset | SelfService |
| subset | VPPCodes |
| subset | VPP |
| subset | AppConfiguration |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDeviceCommands
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevicecommands \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevicecommands HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicecommands',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicecommands',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevicecommands', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevicecommands', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicecommands");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevicecommands
Finds all mobile device commands
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<mobile_device_command>
<id>0</id>
<command>string</command>
<udid>string</udid>
<profile_id>0</profile_id>
</mobile_device_command>
<mobile_devices>
<mobile_device>
<id>0</id>
<udid>string</udid>
<serial_number>string</serial_number>
<phone_number>string</phone_number>
<wifi_mac_address>string</wifi_mac_address>
</mobile_device>
</mobile_devices>
findMobileDeviceCommandsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevicecommands/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevicecommands/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicecommands/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicecommands/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevicecommands/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevicecommands/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicecommands/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevicecommands/id/{id}
Finds a mobile device command by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<command>string</command>
<udid>string</udid>
<uuid>string</uuid>
<profile_id>0</profile_id>
<date_sent>string</date_sent>
<date_sent_epoch>string</date_sent_epoch>
<date_sent_utc>string</date_sent_utc>
<apns_result_status>Acknowledged</apns_result_status>
<profile_udid>string</profile_udid>
</general>
<mobile_devices>
<mobile_device>
<id>0</id>
<udid>string</udid>
<serial_number>string</serial_number>
<phone_number>string</phone_number>
<wifi_mac_address>string</wifi_mac_address>
</mobile_device>
</mobile_devices>
findMobileDeviceCommandsByUuid
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevicecommands/uuid/{uuid} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevicecommands/uuid/{uuid} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicecommands/uuid/{uuid}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicecommands/uuid/{uuid}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevicecommands/uuid/{uuid}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevicecommands/uuid/{uuid}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicecommands/uuid/{uuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevicecommands/uuid/{uuid}
Finds a mobile device command by UUDI
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| uuid | path | string | true | UUID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<command>string</command>
<udid>string</udid>
<uuid>string</uuid>
<profile_id>0</profile_id>
<date_sent>string</date_sent>
<date_sent_epoch>string</date_sent_epoch>
<date_sent_utc>string</date_sent_utc>
<apns_result_status>Acknowledged</apns_result_status>
<profile_udid>string</profile_udid>
</general>
<mobile_devices>
<mobile_device>
<id>0</id>
<udid>string</udid>
<serial_number>string</serial_number>
<phone_number>string</phone_number>
<wifi_mac_address>string</wifi_mac_address>
</mobile_device>
</mobile_devices>
findMobileDeviceCommandsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevicecommands/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevicecommands/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicecommands/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicecommands/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevicecommands/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevicecommands/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicecommands/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevicecommands/name/{name}
Finds all mobile device commands by command name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<command>string</command>
<udid>string</udid>
<uuid>string</uuid>
<profile_id>0</profile_id>
<date_sent>string</date_sent>
<date_sent_epoch>string</date_sent_epoch>
<date_sent_utc>string</date_sent_utc>
<apns_result_status>Acknowledged</apns_result_status>
<profile_udid>string</profile_udid>
</general>
<mobile_devices>
<mobile_device>
<id>0</id>
<udid>string</udid>
<serial_number>string</serial_number>
<phone_number>string</phone_number>
<wifi_mac_address>string</wifi_mac_address>
</mobile_device>
</mobile_devices>
findMobileDeviceCommandsByCommand
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevicecommands/command/{command} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevicecommands/command/{command} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicecommands/command/{command}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicecommands/command/{command}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevicecommands/command/{command}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevicecommands/command/{command}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicecommands/command/{command}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevicecommands/command/{command}
Finds all mobile device commands for specified command
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| command | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<command>string</command>
<udid>string</udid>
<uuid>string</uuid>
<profile_id>0</profile_id>
<date_sent>string</date_sent>
<date_sent_epoch>string</date_sent_epoch>
<date_sent_utc>string</date_sent_utc>
<apns_result_status>Acknowledged</apns_result_status>
<profile_udid>string</profile_udid>
</general>
<mobile_devices>
<mobile_device>
<id>0</id>
<udid>string</udid>
<serial_number>string</serial_number>
<phone_number>string</phone_number>
<wifi_mac_address>string</wifi_mac_address>
</mobile_device>
</mobile_devices>
createMobileDeviceCommand
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/mobiledevicecommands/command \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/mobiledevicecommands/command HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicecommands/command',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"command": "Settings"
},
"mobile_devices": {
"mobile_device": {
"id": 0
}
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicecommands/command',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/mobiledevicecommands/command', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/mobiledevicecommands/command', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicecommands/command");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /mobiledevicecommands/command
Creates a new mobile device command
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | mobile_device_command_post | true | Command name |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<command>Settings</command>
</general>
<mobile_devices>
<mobile_device>
<id>0</id>
</mobile_device>
</mobile_devices>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createMobileDeviceCommandURL
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/mobiledevicecommands/command/{command}/id/{id_list} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/mobiledevicecommands/command/{command}/id/{id_list} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicecommands/command/{command}/id/{id_list}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicecommands/command/{command}/id/{id_list}',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/mobiledevicecommands/command/{command}/id/{id_list}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/mobiledevicecommands/command/{command}/id/{id_list}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicecommands/command/{command}/id/{id_list}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /mobiledevicecommands/command/{command}/id/{id_list}
Creates a new mobile device command
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id_list | path | string | true | Mobile device ID values, multiple IDs may be separated by commas |
| command | path | string | true | Command to send device |
Enumerated Values
| Parameter | Value |
|---|---|
| command | Settings |
| command | EraseDevice |
| command | ClearPasscode |
| command | UnmanageDevice |
| command | UpdateInventory |
| command | ClearRestrictionsPassword |
| command | SettingsEnableDataRoaming |
| command | SettingsDisableDataRoaming |
| command | SettingsEnableVoiceRoaming |
| command | SettingsDisableVoiceRoaming |
| command | SettingsEnableAppAnalytics |
| command | SettingsDisableAppAnalytics |
| command | SettingsEnableDiagnosticSubmission |
| command | SettingsDisableDiagnosticSubmission |
| command | BlankPush |
| command | ShutDownDevice (supervised only) |
| command | RestartDevice (supervised only) |
| command | PasscodeLockGracePeriod (shared iPad only) |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createMobileDeviceNameCommandURL
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/mobiledevicecommands/command/DeviceName/{device_name}/id/{id_list} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/mobiledevicecommands/command/DeviceName/{device_name}/id/{id_list} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicecommands/command/DeviceName/{device_name}/id/{id_list}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicecommands/command/DeviceName/{device_name}/id/{id_list}',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/mobiledevicecommands/command/DeviceName/{device_name}/id/{id_list}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/mobiledevicecommands/command/DeviceName/{device_name}/id/{id_list}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicecommands/command/DeviceName/{device_name}/id/{id_list}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /mobiledevicecommands/command/DeviceName/{device_name}/id/{id_list}
Creates a new command to set the name of a mobile device.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id_list | path | string | true | Mobile device ID values, multiple IDs may be separated by commas |
| device_name | path | string | true | Device name to set |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createMobileDeviceLockCommandURL
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/mobiledevicecommands/command/DeviceLock/{lock_message}/id/{id_list} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/mobiledevicecommands/command/DeviceLock/{lock_message}/id/{id_list} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicecommands/command/DeviceLock/{lock_message}/id/{id_list}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicecommands/command/DeviceLock/{lock_message}/id/{id_list}',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/mobiledevicecommands/command/DeviceLock/{lock_message}/id/{id_list}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/mobiledevicecommands/command/DeviceLock/{lock_message}/id/{id_list}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicecommands/command/DeviceLock/{lock_message}/id/{id_list}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /mobiledevicecommands/command/DeviceLock/{lock_message}/id/{id_list}
Sends a new lock command to a list of mobile devices
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id_list | path | string | true | Mobile device ID values, multiple IDs may be separated by commas |
| lock_message | path | string | true | Lock message for the DeviceLock command |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
findMobileDeviceConfigurationProfiles
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceconfigurationprofiles \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceconfigurationprofiles HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceconfigurationprofiles',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceconfigurationprofiles', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceconfigurationprofiles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceconfigurationprofiles
Finds all mobile device configuration profiles
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<configuration_profiles>
<configuration_profile>
<id>0</id>
<name>string</name>
</configuration_profile>
</configuration_profiles>
findMobileDeviceConfigurationProfilesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceconfigurationprofiles/id/{id}
Finds mobile device configuration profiles by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<configuration_profile>
<general>
<id>0</id>
<name>string</name>
<description>string</description>
<site>
<id>0</id>
<name>string</name>
</site>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<uuid>string</uuid>
<deployment_method>Install Automatically</deployment_method>
<redeploy_on_update>string</redeploy_on_update>
<redeploy_Dayss_before_certificate_expires>0</redeploy_Dayss_before_certificate_expires>
<payloads>string</payloads>
</general>
</configuration_profile>
updateMobileDeviceConfigurationProfileById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledeviceconfigurationprofiles/id/{id}
Updates an existing mobile device configuration profile by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createMobileDeviceConfigurationProfileById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"id": 0,
"name": "string",
"description": "string",
"site": {
"id": 0,
"name": "string"
},
"category": {
"id": 0,
"name": "Category name",
"priority": 9
},
"uuid": "string",
"deployment_method": "Install Automatically",
"redeploy_on_update": "string",
"redeploy_Dayss_before_certificate_expires": 0,
"payloads": "string"
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /mobiledeviceconfigurationprofiles/id/{id}
Creates a new mobile device configuration profile by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | mobile_device_configuration_profile | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<configuration_profile>
<general>
<id>0</id>
<name>string</name>
<description>string</description>
<site>
<id>0</id>
<name>string</name>
</site>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<uuid>string</uuid>
<deployment_method>Install Automatically</deployment_method>
<redeploy_on_update>string</redeploy_on_update>
<redeploy_Dayss_before_certificate_expires>0</redeploy_Dayss_before_certificate_expires>
<payloads>string</payloads>
</general>
</configuration_profile>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobileDeviceConfigurationProfileById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledeviceconfigurationprofiles/id/{id}
Deletes a mobile device configuration profile by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDeviceConfigurationProfilesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceconfigurationprofiles/name/{name}
Finds mobile device configuration profiles by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<configuration_profile>
<general>
<id>0</id>
<name>string</name>
<description>string</description>
<site>
<id>0</id>
<name>string</name>
</site>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<uuid>string</uuid>
<deployment_method>Install Automatically</deployment_method>
<redeploy_on_update>string</redeploy_on_update>
<redeploy_Dayss_before_certificate_expires>0</redeploy_Dayss_before_certificate_expires>
<payloads>string</payloads>
</general>
</configuration_profile>
updateMobileDeviceConfigurationProfileByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledeviceconfigurationprofiles/name/{name}
Updates an existing mobile device configuration profile by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobileDeviceConfigurationProfileByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceconfigurationprofiles/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledeviceconfigurationprofiles/name/{name}
Deletes a mobile device configuration profile by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDeviceConfigurationProfilesByIdSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceconfigurationprofiles/id/{id}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceconfigurationprofiles/id/{id}/subset/{subset}
Display subsets of information for a mobile device configuration profile
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID to filter by |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | General |
| subset | Scope |
| subset | SelfService |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDeviceEnrollmentProfiles
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceenrollmentprofiles \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceenrollmentprofiles HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceenrollmentprofiles',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceenrollmentprofiles', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceenrollmentprofiles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceenrollmentprofiles
Finds all mobile device enrollment profiles
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<mobile_device_enrollment_profile>
<id>0</id>
<name>string</name>
<invitation>string</invitation>
</mobile_device_enrollment_profile>
findMobileDeviceEnrollmentProfilesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceenrollmentprofiles/id/{id}
Finds mobile device enrollment profiles by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<invitation>string</invitation>
<udid>string</udid>
<description>string</description>
</general>
<location>
<username>string</username>
<realname>string</realname>
<real_name>string</real_name>
<email_address>string</email_address>
<position>string</position>
<phone>string</phone>
<phone_number>string</phone_number>
<department>string</department>
<building>string</building>
<room>string</room>
</location>
<purchasing>
<is_purchased>true</is_purchased>
<is_leased>true</is_leased>
<po_number>string</po_number>
<vendor>string</vendor>
<applecare_id>string</applecare_id>
<purchase_price>string</purchase_price>
<purchasing_account>string</purchasing_account>
<po_date>string</po_date>
<po_date_epoch>0</po_date_epoch>
<po_date_utc>string</po_date_utc>
<warranty_expires>string</warranty_expires>
<warranty_expires_epoch>0</warranty_expires_epoch>
<warranty_expires_utc>string</warranty_expires_utc>
<lease_expires>string</lease_expires>
<lease_expires_epoch>0</lease_expires_epoch>
<lease_expires_utc>string</lease_expires_utc>
<life_expectancy>0</life_expectancy>
<purchasing_contact>string</purchasing_contact>
</purchasing>
updateMobileDeviceEnrollmentProfileById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledeviceenrollmentprofiles/id/{id}
Updates an existing mobile device enrollment profile by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createMobileDeviceEnrollmentProfilesById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"id": 0,
"name": "string",
"invitation": "string",
"udid": "string",
"description": "string"
},
"location": {
"username": "string",
"realname": "string",
"real_name": "string",
"email_address": "string",
"position": "string",
"phone": "string",
"phone_number": "string",
"department": "string",
"building": "string",
"room": "string"
},
"purchasing": {
"is_purchased": true,
"is_leased": true,
"po_number": "string",
"vendor": "string",
"applecare_id": "string",
"purchase_price": "string",
"purchasing_account": "string",
"po_date": "string",
"po_date_epoch": 0,
"po_date_utc": "string",
"warranty_expires": "string",
"warranty_expires_epoch": 0,
"warranty_expires_utc": "string",
"lease_expires": "string",
"lease_expires_epoch": 0,
"lease_expires_utc": "string",
"life_expectancy": 0,
"purchasing_contact": "string"
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /mobiledeviceenrollmentprofiles/id/{id}
Creates a new mobile device enrollment profile by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | mobile_device_enrollment_profile | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<invitation>string</invitation>
<udid>string</udid>
<description>string</description>
</general>
<location>
<username>string</username>
<realname>string</realname>
<real_name>string</real_name>
<email_address>string</email_address>
<position>string</position>
<phone>string</phone>
<phone_number>string</phone_number>
<department>string</department>
<building>string</building>
<room>string</room>
</location>
<purchasing>
<is_purchased>true</is_purchased>
<is_leased>true</is_leased>
<po_number>string</po_number>
<vendor>string</vendor>
<applecare_id>string</applecare_id>
<purchase_price>string</purchase_price>
<purchasing_account>string</purchasing_account>
<po_date>string</po_date>
<po_date_epoch>0</po_date_epoch>
<po_date_utc>string</po_date_utc>
<warranty_expires>string</warranty_expires>
<warranty_expires_epoch>0</warranty_expires_epoch>
<warranty_expires_utc>string</warranty_expires_utc>
<lease_expires>string</lease_expires>
<lease_expires_epoch>0</lease_expires_epoch>
<lease_expires_utc>string</lease_expires_utc>
<life_expectancy>0</life_expectancy>
<purchasing_contact>string</purchasing_contact>
</purchasing>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobileDeviceEnrollmentProfileById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledeviceenrollmentprofiles/id/{id}
Deletes a mobile device enrollment profile by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDeviceEnrollmentProfilesByInvitation
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceenrollmentprofiles/invitation/{invitation}
Finds mobile device enrollment profiles by invitation
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| invitation | path | string | true | Invitation value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<invitation>string</invitation>
<udid>string</udid>
<description>string</description>
</general>
<location>
<username>string</username>
<realname>string</realname>
<real_name>string</real_name>
<email_address>string</email_address>
<position>string</position>
<phone>string</phone>
<phone_number>string</phone_number>
<department>string</department>
<building>string</building>
<room>string</room>
</location>
<purchasing>
<is_purchased>true</is_purchased>
<is_leased>true</is_leased>
<po_number>string</po_number>
<vendor>string</vendor>
<applecare_id>string</applecare_id>
<purchase_price>string</purchase_price>
<purchasing_account>string</purchasing_account>
<po_date>string</po_date>
<po_date_epoch>0</po_date_epoch>
<po_date_utc>string</po_date_utc>
<warranty_expires>string</warranty_expires>
<warranty_expires_epoch>0</warranty_expires_epoch>
<warranty_expires_utc>string</warranty_expires_utc>
<lease_expires>string</lease_expires>
<lease_expires_epoch>0</lease_expires_epoch>
<lease_expires_utc>string</lease_expires_utc>
<life_expectancy>0</life_expectancy>
<purchasing_contact>string</purchasing_contact>
</purchasing>
updateMobileDeviceEnrollmentProfileByInvitation
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledeviceenrollmentprofiles/invitation/{invitation}
Updates an existing mobile device enrollment profile by invitation
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| invitation | path | string | true | Invitation value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobileDeviceEnrollmentProfileByInvitation
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceenrollmentprofiles/invitation/{invitation}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledeviceenrollmentprofiles/invitation/{invitation}
Deletes a mobile device enrollment profile by invitation
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| invitation | path | string | true | Invitation value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDeviceEnrollmentProfilesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceenrollmentprofiles/name/{name}
Finds mobile device enrollment profiles by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<invitation>string</invitation>
<udid>string</udid>
<description>string</description>
</general>
<location>
<username>string</username>
<realname>string</realname>
<real_name>string</real_name>
<email_address>string</email_address>
<position>string</position>
<phone>string</phone>
<phone_number>string</phone_number>
<department>string</department>
<building>string</building>
<room>string</room>
</location>
<purchasing>
<is_purchased>true</is_purchased>
<is_leased>true</is_leased>
<po_number>string</po_number>
<vendor>string</vendor>
<applecare_id>string</applecare_id>
<purchase_price>string</purchase_price>
<purchasing_account>string</purchasing_account>
<po_date>string</po_date>
<po_date_epoch>0</po_date_epoch>
<po_date_utc>string</po_date_utc>
<warranty_expires>string</warranty_expires>
<warranty_expires_epoch>0</warranty_expires_epoch>
<warranty_expires_utc>string</warranty_expires_utc>
<lease_expires>string</lease_expires>
<lease_expires_epoch>0</lease_expires_epoch>
<lease_expires_utc>string</lease_expires_utc>
<life_expectancy>0</life_expectancy>
<purchasing_contact>string</purchasing_contact>
</purchasing>
updateMobileDeviceEnrollmentProfileByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledeviceenrollmentprofiles/name/{name}
Updates an existing mobile device enrollment profile by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobileDeviceEnrollmentProfileByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceenrollmentprofiles/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledeviceenrollmentprofiles/name/{name}
Deletes a mobile device enrollment profile by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDeviceEnrollmentProfilesByIdSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceenrollmentprofiles/id/{id}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceenrollmentprofiles/id/{id}/subset/{subset}
Display subsets of information for an enrollment profile
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID to filter by |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | General |
| subset | Location |
| subset | Purchasing |
| subset | Attachments |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobiledeviceextensionattributes
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceextensionattributes \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceextensionattributes HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceextensionattributes',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceextensionattributes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceextensionattributes', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceextensionattributes', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceextensionattributes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceextensionattributes
Finds all mobile device extension attributes
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<mobile_device_extension_attribute>
<id>0</id>
<name>string</name>
</mobile_device_extension_attribute>
findMobiledeviceextensionattributesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceextensionattributes/id/{id}
Finds mobile device extension attributes by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<date_type>String</date_type>
<input_type>
<type>Text Field</type>
</input_type>
<inventory_display>General</inventory_display>
updateMobiledeviceextensionattributeById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledeviceextensionattributes/id/{id}
Updates an existing mobile device extension attribute by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createMobiledeviceextensionattributeById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"description": "string",
"date_type": "String",
"input_type": {
"type": "Text Field"
},
"inventory_display": "General"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /mobiledeviceextensionattributes/id/{id}
Creates a new mobile device extension attribute by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | mobile_device_extension_attribute | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<date_type>String</date_type>
<input_type>
<type>Text Field</type>
</input_type>
<inventory_display>General</inventory_display>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobiledeviceextensionattributeById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceextensionattributes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledeviceextensionattributes/id/{id}
Deletes a mobile device extension attribute by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobiledeviceextensionattributesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledeviceextensionattributes/name/{name}
Finds mobiledeviceextensionattributes by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<date_type>String</date_type>
<input_type>
<type>Text Field</type>
</input_type>
<inventory_display>General</inventory_display>
updateMobiledeviceextensionattributeByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledeviceextensionattributes/name/{name}
Updates an existing mobile device extension attribute by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobiledeviceextensionattributeByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledeviceextensionattributes/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledeviceextensionattributes/name/{name}
Deletes a mobile device extension attribute by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDeviceGroups
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevicegroups \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevicegroups HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicegroups',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicegroups',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevicegroups', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevicegroups', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicegroups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevicegroups
Finds all mobile device groups
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<mobile_device_group>
<id>0</id>
<name>string</name>
<is_smart>true</is_smart>
</mobile_device_group>
findMobileDeviceGroupsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevicegroups/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevicegroups/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicegroups/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicegroups/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevicegroups/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevicegroups/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicegroups/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevicegroups/id/{id}
Finds mobile device groups by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<is_smart>true</is_smart>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<site>
<id>0</id>
<name>string</name>
</site>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
<mac_address>string</mac_address>
<udid>string</udid>
<wifi_mac_address>string</wifi_mac_address>
<serial_number>string</serial_number>
</mobile_device>
</mobile_devices>
updateMobileDeviceGroupById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledevicegroups/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledevicegroups/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicegroups/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicegroups/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledevicegroups/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledevicegroups/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicegroups/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledevicegroups/id/{id}
Updates an existing mobile device group by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createMobileDeviceGroupById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/mobiledevicegroups/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/mobiledevicegroups/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicegroups/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"is_smart": true,
"criteria": {
"criterion": {
"name": "string",
"priority": 0,
"and_or": "and",
"search_type": "string",
"value": "string",
"opening_paren": true,
"closing_paren": true
}
},
"site": {
"id": 0,
"name": "string"
},
"mobile_devices": {
"mobile_device": {
"id": 0,
"name": "string",
"mac_address": "string",
"udid": "string",
"wifi_mac_address": "string",
"serial_number": "string"
}
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicegroups/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/mobiledevicegroups/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/mobiledevicegroups/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicegroups/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /mobiledevicegroups/id/{id}
Creates a new mobile device group by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | mobile_device_group | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<is_smart>true</is_smart>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<site>
<id>0</id>
<name>string</name>
</site>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
<mac_address>string</mac_address>
<udid>string</udid>
<wifi_mac_address>string</wifi_mac_address>
<serial_number>string</serial_number>
</mobile_device>
</mobile_devices>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobileDeviceGroupById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledevicegroups/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledevicegroups/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicegroups/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicegroups/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledevicegroups/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledevicegroups/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicegroups/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledevicegroups/id/{id}
Deletes a mobile device group by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDeviceGroupsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevicegroups/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevicegroups/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicegroups/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicegroups/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevicegroups/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevicegroups/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicegroups/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevicegroups/name/{name}
Finds mobile device groups by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<is_smart>true</is_smart>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<site>
<id>0</id>
<name>string</name>
</site>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
<mac_address>string</mac_address>
<udid>string</udid>
<wifi_mac_address>string</wifi_mac_address>
<serial_number>string</serial_number>
</mobile_device>
</mobile_devices>
updateMobileDeviceGroupByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledevicegroups/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledevicegroups/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicegroups/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicegroups/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledevicegroups/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledevicegroups/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicegroups/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledevicegroups/name/{name}
Updates an existing mobile device group by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobileDeviceGroupByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledevicegroups/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledevicegroups/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicegroups/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicegroups/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledevicegroups/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledevicegroups/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicegroups/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledevicegroups/name/{name}
Deletes a mobile device group by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDeviceHistoryById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevicehistory/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevicehistory/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicehistory/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicehistory/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevicehistory/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevicehistory/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicehistory/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevicehistory/id/{id}
Finds mobile device history by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findMobileDeviceHistoryByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevicehistory/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevicehistory/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicehistory/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicehistory/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevicehistory/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevicehistory/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicehistory/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevicehistory/name/{name}
Finds mobile device history by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findMobileDeviceHistoryByUDID
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevicehistory/udid/{udid} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevicehistory/udid/{udid} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicehistory/udid/{udid}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicehistory/udid/{udid}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevicehistory/udid/{udid}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevicehistory/udid/{udid}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicehistory/udid/{udid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevicehistory/udid/{udid}
Finds mobile device history by UDID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| udid | path | string | true | UDID to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findMobileDeviceHistoryBySerialNumber
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevicehistory/serialnumber/{serialnumber} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevicehistory/serialnumber/{serialnumber} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicehistory/serialnumber/{serialnumber}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicehistory/serialnumber/{serialnumber}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevicehistory/serialnumber/{serialnumber}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevicehistory/serialnumber/{serialnumber}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicehistory/serialnumber/{serialnumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevicehistory/serialnumber/{serialnumber}
Finds mobile device history by serial number
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| serialnumber | path | string | true | Serial number to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findMobileDeviceHistoryByMacAddress
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevicehistory/macaddress/{macaddress} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevicehistory/macaddress/{macaddress} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicehistory/macaddress/{macaddress}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicehistory/macaddress/{macaddress}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevicehistory/macaddress/{macaddress}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevicehistory/macaddress/{macaddress}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicehistory/macaddress/{macaddress}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevicehistory/macaddress/{macaddress}
Finds mobile device history by wifi mac address
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| macaddress | path | string | true | Mac address to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<udid>string</udid>
<serial_number>string</serial_number>
<mac_address>string</mac_address>
</general>
findMobileDeviceHistoryByIdSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevicehistory/id/{id}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevicehistory/id/{id}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevicehistory/id/{id}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevicehistory/id/{id}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevicehistory/id/{id}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevicehistory/id/{id}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevicehistory/id/{id}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevicehistory/id/{id}/subset/{subset}
Display subsets of information for a mobile device history
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID to filter by |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | General |
| subset | ManagementCommands |
| subset | UserLocation |
| subset | Audits |
| subset | Applications |
| subset | Ebooks |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDevices
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevices \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevices HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevices', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevices', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevices
Finds all mobile devices
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<mobile_device>
<id>0</id>
<name>string</name>
<device_name>string</device_name>
<udid>string</udid>
<serial_number>string</serial_number>
<phone_number>string</phone_number>
<wifi_mac_address>string</wifi_mac_address>
<managed>true</managed>
<supervised>true</supervised>
<model>string</model>
<model_identifier>string</model_identifier>
<model_display>string</model_display>
<username>string</username>
</mobile_device>
matchMobileDevices
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevices/match/{match} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevices/match/{match} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/match/{match}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/match/{match}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevices/match/{match}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevices/match/{match}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/match/{match}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevices/match/{match}
Searches for mobile devices that match the provided parameter
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| match | path | string | true | Name, mac address, etc. to filter by. Match uses the same format as the general search in the JSS. |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<display_name>string</display_name>
<device_name>string</device_name>
<name>string</name>
<asset_tag>string</asset_tag>
<last_inventory_update>string</last_inventory_update>
<last_inventory_update_epoch>0</last_inventory_update_epoch>
<last_inventory_update_utc>string</last_inventory_update_utc>
<capacity>0</capacity>
<capacity_mb>0</capacity_mb>
<available>0</available>
<available_mb>0</available_mb>
<percentage_used>0</percentage_used>
<os_type>string</os_type>
<os_version>string</os_version>
<os_build>string</os_build>
<serial_number>string</serial_number>
<udid>string</udid>
<initial_entry_date_epoch>0</initial_entry_date_epoch>
<initial_entry_date_utc>string</initial_entry_date_utc>
<phone_number>string</phone_number>
<ip_address>string</ip_address>
<wifi_mac_address>string</wifi_mac_address>
<bluetooth_mac_address>string</bluetooth_mac_address>
<modem_firmware>string</modem_firmware>
<model>string</model>
<model_identifier>string</model_identifier>
<model_number>string</model_number>
<model_display>string</model_display>
<device_ownership_level>string</device_ownership_level>
<last_enrollment_epoch>0</last_enrollment_epoch>
<last_enrollment_utc>string</last_enrollment_utc>
<managed>true</managed>
<supervised>true</supervised>
<exchange_activesync_device_identifier>string</exchange_activesync_device_identifier>
<shared>string</shared>
<tethered>string</tethered>
<battery_level>0</battery_level>
<ble_capable>true</ble_capable>
<lost_mode_enabled>string</lost_mode_enabled>
<lost_mode_enable_issued_epoch>0</lost_mode_enable_issued_epoch>
<lost_mode_enable_issued_utc>string</lost_mode_enable_issued_utc>
<lost_mode_message>string</lost_mode_message>
<lost_mode_phone>string</lost_mode_phone>
<lost_mode_footnote>string</lost_mode_footnote>
<lost_location_epoch>0</lost_location_epoch>
<lost_location_utc>string</lost_location_utc>
</general>
findMobileDevicesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevices/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevices/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevices/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevices/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevices/id/{id}
Finds mobile devices by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<display_name>string</display_name>
<device_name>string</device_name>
<name>string</name>
<asset_tag>string</asset_tag>
<last_inventory_update>string</last_inventory_update>
<last_inventory_update_epoch>0</last_inventory_update_epoch>
<last_inventory_update_utc>string</last_inventory_update_utc>
<capacity>0</capacity>
<capacity_mb>0</capacity_mb>
<available>0</available>
<available_mb>0</available_mb>
<percentage_used>0</percentage_used>
<os_type>string</os_type>
<os_version>string</os_version>
<os_build>string</os_build>
<serial_number>string</serial_number>
<udid>string</udid>
<initial_entry_date_epoch>0</initial_entry_date_epoch>
<initial_entry_date_utc>string</initial_entry_date_utc>
<phone_number>string</phone_number>
<ip_address>string</ip_address>
<wifi_mac_address>string</wifi_mac_address>
<bluetooth_mac_address>string</bluetooth_mac_address>
<modem_firmware>string</modem_firmware>
<model>string</model>
<model_identifier>string</model_identifier>
<model_number>string</model_number>
<model_display>string</model_display>
<device_ownership_level>string</device_ownership_level>
<last_enrollment_epoch>0</last_enrollment_epoch>
<last_enrollment_utc>string</last_enrollment_utc>
<managed>true</managed>
<supervised>true</supervised>
<exchange_activesync_device_identifier>string</exchange_activesync_device_identifier>
<shared>string</shared>
<tethered>string</tethered>
<battery_level>0</battery_level>
<ble_capable>true</ble_capable>
<lost_mode_enabled>string</lost_mode_enabled>
<lost_mode_enable_issued_epoch>0</lost_mode_enable_issued_epoch>
<lost_mode_enable_issued_utc>string</lost_mode_enable_issued_utc>
<lost_mode_message>string</lost_mode_message>
<lost_mode_phone>string</lost_mode_phone>
<lost_mode_footnote>string</lost_mode_footnote>
<lost_location_epoch>0</lost_location_epoch>
<lost_location_utc>string</lost_location_utc>
</general>
updateMobileDeviceById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledevices/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledevices/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledevices/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledevices/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledevices/id/{id}
Updates an existing mobile device by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createMobileDeviceById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/mobiledevices/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/mobiledevices/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"id": 0,
"display_name": "string",
"device_name": "string",
"name": "string",
"asset_tag": "string",
"last_inventory_update": "string",
"last_inventory_update_epoch": 0,
"last_inventory_update_utc": "string",
"capacity": 0,
"capacity_mb": 0,
"available": 0,
"available_mb": 0,
"percentage_used": 0,
"os_type": "string",
"os_version": "string",
"os_build": "string",
"serial_number": "string",
"udid": "string",
"initial_entry_date_epoch": 0,
"initial_entry_date_utc": "string",
"phone_number": "string",
"ip_address": "string",
"wifi_mac_address": "string",
"bluetooth_mac_address": "string",
"modem_firmware": "string",
"model": "string",
"model_identifier": "string",
"model_number": "string",
"model_display": "string",
"device_ownership_level": "string",
"last_enrollment_epoch": 0,
"last_enrollment_utc": "string",
"managed": true,
"supervised": true,
"exchange_activesync_device_identifier": "string",
"shared": "string",
"tethered": "string",
"battery_level": 0,
"ble_capable": true,
"lost_mode_enabled": "string",
"lost_mode_enable_issued_epoch": 0,
"lost_mode_enable_issued_utc": "string",
"lost_mode_message": "string",
"lost_mode_phone": "string",
"lost_mode_footnote": "string",
"lost_location_epoch": 0,
"lost_location_utc": "string"
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/mobiledevices/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/mobiledevices/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /mobiledevices/id/{id}
Creates a new mobile device by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | mobile_device | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<display_name>string</display_name>
<device_name>string</device_name>
<name>string</name>
<asset_tag>string</asset_tag>
<last_inventory_update>string</last_inventory_update>
<last_inventory_update_epoch>0</last_inventory_update_epoch>
<last_inventory_update_utc>string</last_inventory_update_utc>
<capacity>0</capacity>
<capacity_mb>0</capacity_mb>
<available>0</available>
<available_mb>0</available_mb>
<percentage_used>0</percentage_used>
<os_type>string</os_type>
<os_version>string</os_version>
<os_build>string</os_build>
<serial_number>string</serial_number>
<udid>string</udid>
<initial_entry_date_epoch>0</initial_entry_date_epoch>
<initial_entry_date_utc>string</initial_entry_date_utc>
<phone_number>string</phone_number>
<ip_address>string</ip_address>
<wifi_mac_address>string</wifi_mac_address>
<bluetooth_mac_address>string</bluetooth_mac_address>
<modem_firmware>string</modem_firmware>
<model>string</model>
<model_identifier>string</model_identifier>
<model_number>string</model_number>
<model_display>string</model_display>
<device_ownership_level>string</device_ownership_level>
<last_enrollment_epoch>0</last_enrollment_epoch>
<last_enrollment_utc>string</last_enrollment_utc>
<managed>true</managed>
<supervised>true</supervised>
<exchange_activesync_device_identifier>string</exchange_activesync_device_identifier>
<shared>string</shared>
<tethered>string</tethered>
<battery_level>0</battery_level>
<ble_capable>true</ble_capable>
<lost_mode_enabled>string</lost_mode_enabled>
<lost_mode_enable_issued_epoch>0</lost_mode_enable_issued_epoch>
<lost_mode_enable_issued_utc>string</lost_mode_enable_issued_utc>
<lost_mode_message>string</lost_mode_message>
<lost_mode_phone>string</lost_mode_phone>
<lost_mode_footnote>string</lost_mode_footnote>
<lost_location_epoch>0</lost_location_epoch>
<lost_location_utc>string</lost_location_utc>
</general>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobileDeviceById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledevices/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledevices/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledevices/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledevices/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledevices/id/{id}
Deletes a mobile device by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDevicesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevices/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevices/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevices/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevices/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevices/name/{name}
Finds mobile devices by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<display_name>string</display_name>
<device_name>string</device_name>
<name>string</name>
<asset_tag>string</asset_tag>
<last_inventory_update>string</last_inventory_update>
<last_inventory_update_epoch>0</last_inventory_update_epoch>
<last_inventory_update_utc>string</last_inventory_update_utc>
<capacity>0</capacity>
<capacity_mb>0</capacity_mb>
<available>0</available>
<available_mb>0</available_mb>
<percentage_used>0</percentage_used>
<os_type>string</os_type>
<os_version>string</os_version>
<os_build>string</os_build>
<serial_number>string</serial_number>
<udid>string</udid>
<initial_entry_date_epoch>0</initial_entry_date_epoch>
<initial_entry_date_utc>string</initial_entry_date_utc>
<phone_number>string</phone_number>
<ip_address>string</ip_address>
<wifi_mac_address>string</wifi_mac_address>
<bluetooth_mac_address>string</bluetooth_mac_address>
<modem_firmware>string</modem_firmware>
<model>string</model>
<model_identifier>string</model_identifier>
<model_number>string</model_number>
<model_display>string</model_display>
<device_ownership_level>string</device_ownership_level>
<last_enrollment_epoch>0</last_enrollment_epoch>
<last_enrollment_utc>string</last_enrollment_utc>
<managed>true</managed>
<supervised>true</supervised>
<exchange_activesync_device_identifier>string</exchange_activesync_device_identifier>
<shared>string</shared>
<tethered>string</tethered>
<battery_level>0</battery_level>
<ble_capable>true</ble_capable>
<lost_mode_enabled>string</lost_mode_enabled>
<lost_mode_enable_issued_epoch>0</lost_mode_enable_issued_epoch>
<lost_mode_enable_issued_utc>string</lost_mode_enable_issued_utc>
<lost_mode_message>string</lost_mode_message>
<lost_mode_phone>string</lost_mode_phone>
<lost_mode_footnote>string</lost_mode_footnote>
<lost_location_epoch>0</lost_location_epoch>
<lost_location_utc>string</lost_location_utc>
</general>
updateMobileDeviceByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledevices/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledevices/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledevices/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledevices/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledevices/name/{name}
Updates an existing mobile device by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobileDeviceByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledevices/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledevices/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledevices/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledevices/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledevices/name/{name}
Deletes a mobile device by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDevicesByUDID
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevices/udid/{udid} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevices/udid/{udid} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/udid/{udid}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/udid/{udid}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevices/udid/{udid}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevices/udid/{udid}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/udid/{udid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevices/udid/{udid}
Finds mobile devices by UDID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| udid | path | string | true | UDID to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<display_name>string</display_name>
<device_name>string</device_name>
<name>string</name>
<asset_tag>string</asset_tag>
<last_inventory_update>string</last_inventory_update>
<last_inventory_update_epoch>0</last_inventory_update_epoch>
<last_inventory_update_utc>string</last_inventory_update_utc>
<capacity>0</capacity>
<capacity_mb>0</capacity_mb>
<available>0</available>
<available_mb>0</available_mb>
<percentage_used>0</percentage_used>
<os_type>string</os_type>
<os_version>string</os_version>
<os_build>string</os_build>
<serial_number>string</serial_number>
<udid>string</udid>
<initial_entry_date_epoch>0</initial_entry_date_epoch>
<initial_entry_date_utc>string</initial_entry_date_utc>
<phone_number>string</phone_number>
<ip_address>string</ip_address>
<wifi_mac_address>string</wifi_mac_address>
<bluetooth_mac_address>string</bluetooth_mac_address>
<modem_firmware>string</modem_firmware>
<model>string</model>
<model_identifier>string</model_identifier>
<model_number>string</model_number>
<model_display>string</model_display>
<device_ownership_level>string</device_ownership_level>
<last_enrollment_epoch>0</last_enrollment_epoch>
<last_enrollment_utc>string</last_enrollment_utc>
<managed>true</managed>
<supervised>true</supervised>
<exchange_activesync_device_identifier>string</exchange_activesync_device_identifier>
<shared>string</shared>
<tethered>string</tethered>
<battery_level>0</battery_level>
<ble_capable>true</ble_capable>
<lost_mode_enabled>string</lost_mode_enabled>
<lost_mode_enable_issued_epoch>0</lost_mode_enable_issued_epoch>
<lost_mode_enable_issued_utc>string</lost_mode_enable_issued_utc>
<lost_mode_message>string</lost_mode_message>
<lost_mode_phone>string</lost_mode_phone>
<lost_mode_footnote>string</lost_mode_footnote>
<lost_location_epoch>0</lost_location_epoch>
<lost_location_utc>string</lost_location_utc>
</general>
updateMobileDeviceByUDID
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledevices/udid/{udid} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledevices/udid/{udid} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/udid/{udid}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/udid/{udid}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledevices/udid/{udid}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledevices/udid/{udid}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/udid/{udid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledevices/udid/{udid}
Updates an existing mobile device by UDID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| udid | path | string | true | UDID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobileDeviceByUDID
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledevices/udid/{udid} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledevices/udid/{udid} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/udid/{udid}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/udid/{udid}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledevices/udid/{udid}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledevices/udid/{udid}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/udid/{udid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledevices/udid/{udid}
Deletes a mobile device by UDID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| udid | path | string | true | UDID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDevicesBySerialNumber
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevices/serialnumber/{serialnumber}
Finds mobile devices by serial number
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| serialnumber | path | string | true | Serial number to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<display_name>string</display_name>
<device_name>string</device_name>
<name>string</name>
<asset_tag>string</asset_tag>
<last_inventory_update>string</last_inventory_update>
<last_inventory_update_epoch>0</last_inventory_update_epoch>
<last_inventory_update_utc>string</last_inventory_update_utc>
<capacity>0</capacity>
<capacity_mb>0</capacity_mb>
<available>0</available>
<available_mb>0</available_mb>
<percentage_used>0</percentage_used>
<os_type>string</os_type>
<os_version>string</os_version>
<os_build>string</os_build>
<serial_number>string</serial_number>
<udid>string</udid>
<initial_entry_date_epoch>0</initial_entry_date_epoch>
<initial_entry_date_utc>string</initial_entry_date_utc>
<phone_number>string</phone_number>
<ip_address>string</ip_address>
<wifi_mac_address>string</wifi_mac_address>
<bluetooth_mac_address>string</bluetooth_mac_address>
<modem_firmware>string</modem_firmware>
<model>string</model>
<model_identifier>string</model_identifier>
<model_number>string</model_number>
<model_display>string</model_display>
<device_ownership_level>string</device_ownership_level>
<last_enrollment_epoch>0</last_enrollment_epoch>
<last_enrollment_utc>string</last_enrollment_utc>
<managed>true</managed>
<supervised>true</supervised>
<exchange_activesync_device_identifier>string</exchange_activesync_device_identifier>
<shared>string</shared>
<tethered>string</tethered>
<battery_level>0</battery_level>
<ble_capable>true</ble_capable>
<lost_mode_enabled>string</lost_mode_enabled>
<lost_mode_enable_issued_epoch>0</lost_mode_enable_issued_epoch>
<lost_mode_enable_issued_utc>string</lost_mode_enable_issued_utc>
<lost_mode_message>string</lost_mode_message>
<lost_mode_phone>string</lost_mode_phone>
<lost_mode_footnote>string</lost_mode_footnote>
<lost_location_epoch>0</lost_location_epoch>
<lost_location_utc>string</lost_location_utc>
</general>
updateMobileDeviceBySerialNumber
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledevices/serialnumber/{serialnumber}
Updates an existing mobile device by serial number
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| serialnumber | path | string | true | Serial number value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobileDeviceBySerialNumber
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/serialnumber/{serialnumber}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledevices/serialnumber/{serialnumber}
Deletes a mobile device by serial number
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| serialnumber | path | string | true | Serial number value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDevicesByMacAddress
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevices/macaddress/{macaddress} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevices/macaddress/{macaddress} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/macaddress/{macaddress}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/macaddress/{macaddress}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevices/macaddress/{macaddress}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevices/macaddress/{macaddress}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/macaddress/{macaddress}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevices/macaddress/{macaddress}
Finds mobile devices by Mac address
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| macaddress | path | string | true | Mac address to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<display_name>string</display_name>
<device_name>string</device_name>
<name>string</name>
<asset_tag>string</asset_tag>
<last_inventory_update>string</last_inventory_update>
<last_inventory_update_epoch>0</last_inventory_update_epoch>
<last_inventory_update_utc>string</last_inventory_update_utc>
<capacity>0</capacity>
<capacity_mb>0</capacity_mb>
<available>0</available>
<available_mb>0</available_mb>
<percentage_used>0</percentage_used>
<os_type>string</os_type>
<os_version>string</os_version>
<os_build>string</os_build>
<serial_number>string</serial_number>
<udid>string</udid>
<initial_entry_date_epoch>0</initial_entry_date_epoch>
<initial_entry_date_utc>string</initial_entry_date_utc>
<phone_number>string</phone_number>
<ip_address>string</ip_address>
<wifi_mac_address>string</wifi_mac_address>
<bluetooth_mac_address>string</bluetooth_mac_address>
<modem_firmware>string</modem_firmware>
<model>string</model>
<model_identifier>string</model_identifier>
<model_number>string</model_number>
<model_display>string</model_display>
<device_ownership_level>string</device_ownership_level>
<last_enrollment_epoch>0</last_enrollment_epoch>
<last_enrollment_utc>string</last_enrollment_utc>
<managed>true</managed>
<supervised>true</supervised>
<exchange_activesync_device_identifier>string</exchange_activesync_device_identifier>
<shared>string</shared>
<tethered>string</tethered>
<battery_level>0</battery_level>
<ble_capable>true</ble_capable>
<lost_mode_enabled>string</lost_mode_enabled>
<lost_mode_enable_issued_epoch>0</lost_mode_enable_issued_epoch>
<lost_mode_enable_issued_utc>string</lost_mode_enable_issued_utc>
<lost_mode_message>string</lost_mode_message>
<lost_mode_phone>string</lost_mode_phone>
<lost_mode_footnote>string</lost_mode_footnote>
<lost_location_epoch>0</lost_location_epoch>
<lost_location_utc>string</lost_location_utc>
</general>
updateMobileDeviceByMacAddress
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/mobiledevices/macaddress/{macaddress} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/mobiledevices/macaddress/{macaddress} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/macaddress/{macaddress}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/macaddress/{macaddress}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/mobiledevices/macaddress/{macaddress}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/mobiledevices/macaddress/{macaddress}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/macaddress/{macaddress}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /mobiledevices/macaddress/{macaddress}
Updates an existing mobile device by Mac address
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| macaddress | path | string | true | Mac address value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteMobileDeviceByMacAddress
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/mobiledevices/macaddress/{macaddress} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/mobiledevices/macaddress/{macaddress} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/macaddress/{macaddress}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/macaddress/{macaddress}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/mobiledevices/macaddress/{macaddress}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/mobiledevices/macaddress/{macaddress}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/macaddress/{macaddress}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /mobiledevices/macaddress/{macaddress}
Deletes a mobile device by Mac address
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| macaddress | path | string | true | Mac address value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findMobileDevicesByIdSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/mobiledevices/id/{id}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/mobiledevices/id/{id}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/mobiledevices/id/{id}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/mobiledevices/id/{id}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/mobiledevices/id/{id}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/mobiledevices/id/{id}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/mobiledevices/id/{id}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /mobiledevices/id/{id}/subset/{subset}
Display subsets of information for a mobile device
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID to filter by |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | General |
| subset | Location |
| subset | Purchasing |
| subset | Applications |
| subset | Security |
| subset | Network |
| subset | Certificates |
| subset | ConfigurationProfiles |
| subset | ProvisioningProfiles |
| subset | MobileDeviceGroups |
| subset | ExtensionAttributes |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findNetbootServers
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/netbootservers \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/netbootservers HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/netbootservers',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/netbootservers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/netbootservers', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/netbootservers', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/netbootservers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /netbootservers
Finds all netboot servers
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<netboot_server>
<id>0</id>
<name>string</name>
</netboot_server>
findNetbootServersById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/netbootservers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/netbootservers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/netbootservers/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/netbootservers/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/netbootservers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/netbootservers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/netbootservers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /netbootservers/id/{id}
Finds netboot servers by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<ip_address>string</ip_address>
<default_image>true</default_image>
<specific_image>false</specific_image>
<target_platform>PowerPC</target_platform>
<share_point>string</share_point>
<set>string</set>
<image>string</image>
<protocol>nfs</protocol>
<configure_manually>true</configure_manually>
<boot_args>string</boot_args>
<boot_file>string</boot_file>
<boot_device>string</boot_device>
updateNetbootServerById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/netbootservers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/netbootservers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/netbootservers/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/netbootservers/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/netbootservers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/netbootservers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/netbootservers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /netbootservers/id/{id}
Updates an existing netboot server by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createNetbootServerById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/netbootservers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/netbootservers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/netbootservers/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"ip_address": "string",
"default_image": true,
"specific_image": false,
"target_platform": "PowerPC",
"share_point": "string",
"set": "string",
"image": "string",
"protocol": "nfs",
"configure_manually": true,
"boot_args": "string",
"boot_file": "string",
"boot_device": "string"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/netbootservers/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/netbootservers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/netbootservers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/netbootservers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /netbootservers/id/{id}
Creates a new netboot server by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | netboot_server | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<ip_address>string</ip_address>
<default_image>true</default_image>
<specific_image>false</specific_image>
<target_platform>PowerPC</target_platform>
<share_point>string</share_point>
<set>string</set>
<image>string</image>
<protocol>nfs</protocol>
<configure_manually>true</configure_manually>
<boot_args>string</boot_args>
<boot_file>string</boot_file>
<boot_device>string</boot_device>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteNetbootServerById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/netbootservers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/netbootservers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/netbootservers/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/netbootservers/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/netbootservers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/netbootservers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/netbootservers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /netbootservers/id/{id}
Deletes a netboot server by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findNetbootServersByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/netbootservers/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/netbootservers/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/netbootservers/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/netbootservers/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/netbootservers/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/netbootservers/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/netbootservers/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /netbootservers/name/{name}
Finds netboot servers by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<ip_address>string</ip_address>
<default_image>true</default_image>
<specific_image>false</specific_image>
<target_platform>PowerPC</target_platform>
<share_point>string</share_point>
<set>string</set>
<image>string</image>
<protocol>nfs</protocol>
<configure_manually>true</configure_manually>
<boot_args>string</boot_args>
<boot_file>string</boot_file>
<boot_device>string</boot_device>
updateNetbootServerByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/netbootservers/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/netbootservers/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/netbootservers/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/netbootservers/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/netbootservers/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/netbootservers/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/netbootservers/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /netbootservers/name/{name}
Updates an existing netboot server by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteNetbootServerByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/netbootservers/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/netbootservers/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/netbootservers/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/netbootservers/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/netbootservers/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/netbootservers/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/netbootservers/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /netbootservers/name/{name}
Deletes a netboot server by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findNetworkSegments
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/networksegments \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/networksegments HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/networksegments',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/networksegments',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/networksegments', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/networksegments', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/networksegments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /networksegments
Finds all network segments
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<network_segment>
<id>0</id>
<name>string</name>
<starting_address>string</starting_address>
<ending_address>string</ending_address>
</network_segment>
findNetworkSegmentsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/networksegments/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/networksegments/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/networksegments/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/networksegments/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/networksegments/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/networksegments/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/networksegments/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /networksegments/id/{id}
Finds network segments by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<starting_address>string</starting_address>
<ending_address>string</ending_address>
<distribution_server>string</distribution_server>
<distribution_point>string</distribution_point>
<url>string</url>
<netboot_server>string</netboot_server>
<swu_server>string</swu_server>
<building>string</building>
<department>string</department>
<override_buildings>false</override_buildings>
<override_departments>false</override_departments>
updateNetworkSegmentById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/networksegments/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/networksegments/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/networksegments/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/networksegments/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/networksegments/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/networksegments/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/networksegments/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /networksegments/id/{id}
Updates an existing network segment by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createNetworkSegmentById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/networksegments/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/networksegments/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/networksegments/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"starting_address": "string",
"ending_address": "string",
"distribution_server": "string",
"distribution_point": "string",
"url": "string",
"netboot_server": "string",
"swu_server": "string",
"building": "string",
"department": "string",
"override_buildings": false,
"override_departments": false
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/networksegments/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/networksegments/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/networksegments/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/networksegments/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /networksegments/id/{id}
Creates a new network segment by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | network_segment | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<starting_address>string</starting_address>
<ending_address>string</ending_address>
<distribution_server>string</distribution_server>
<distribution_point>string</distribution_point>
<url>string</url>
<netboot_server>string</netboot_server>
<swu_server>string</swu_server>
<building>string</building>
<department>string</department>
<override_buildings>false</override_buildings>
<override_departments>false</override_departments>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteNetworkSegmentById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/networksegments/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/networksegments/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/networksegments/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/networksegments/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/networksegments/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/networksegments/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/networksegments/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /networksegments/id/{id}
Deletes a network segment by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findNetworkSegmentsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/networksegments/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/networksegments/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/networksegments/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/networksegments/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/networksegments/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/networksegments/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/networksegments/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /networksegments/name/{name}
Finds network segments by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<starting_address>string</starting_address>
<ending_address>string</ending_address>
<distribution_server>string</distribution_server>
<distribution_point>string</distribution_point>
<url>string</url>
<netboot_server>string</netboot_server>
<swu_server>string</swu_server>
<building>string</building>
<department>string</department>
<override_buildings>false</override_buildings>
<override_departments>false</override_departments>
updateNetworkSegmentByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/networksegments/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/networksegments/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/networksegments/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/networksegments/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/networksegments/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/networksegments/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/networksegments/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /networksegments/name/{name}
Updates an existing network segment by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteNetworkSegmentByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/networksegments/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/networksegments/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/networksegments/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/networksegments/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/networksegments/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/networksegments/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/networksegments/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /networksegments/name/{name}
Deletes a network segment by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findOsxConfigurationProfiles
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/osxconfigurationprofiles \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/osxconfigurationprofiles HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/osxconfigurationprofiles',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/osxconfigurationprofiles',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/osxconfigurationprofiles', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/osxconfigurationprofiles', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/osxconfigurationprofiles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /osxconfigurationprofiles
Finds all OS X configuration profiles
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<os_x_configuration_profile>
<id>0</id>
<name>string</name>
</os_x_configuration_profile>
findOsxConfigurationProfilesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/osxconfigurationprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/osxconfigurationprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/osxconfigurationprofiles/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/osxconfigurationprofiles/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/osxconfigurationprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/osxconfigurationprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/osxconfigurationprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /osxconfigurationprofiles/id/{id}
Finds OS X configuration profiles by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<description>string</description>
<site>
<id>0</id>
<name>string</name>
</site>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<distribution_method>string</distribution_method>
<user_removable>true</user_removable>
<level>computer</level>
<uuid>string</uuid>
<redeploy_on_update>string</redeploy_on_update>
<payloads>string</payloads>
</general>
updateOsxConfigurationProfileById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/osxconfigurationprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/osxconfigurationprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/osxconfigurationprofiles/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/osxconfigurationprofiles/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/osxconfigurationprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/osxconfigurationprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/osxconfigurationprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /osxconfigurationprofiles/id/{id}
Updates an existing OS X configuration profile by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createOsxConfigurationProfileById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/osxconfigurationprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/osxconfigurationprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/osxconfigurationprofiles/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"id": 0,
"name": "string",
"description": "string",
"site": {
"id": 0,
"name": "string"
},
"category": {
"id": 0,
"name": "Category name",
"priority": 9
},
"distribution_method": "string",
"user_removable": true,
"level": "computer",
"uuid": "string",
"redeploy_on_update": "string",
"payloads": "string"
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/osxconfigurationprofiles/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/osxconfigurationprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/osxconfigurationprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/osxconfigurationprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /osxconfigurationprofiles/id/{id}
Creates a new OS X configuration profile by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | os_x_configuration_profile | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<description>string</description>
<site>
<id>0</id>
<name>string</name>
</site>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<distribution_method>string</distribution_method>
<user_removable>true</user_removable>
<level>computer</level>
<uuid>string</uuid>
<redeploy_on_update>string</redeploy_on_update>
<payloads>string</payloads>
</general>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteOsxConfigurationProfileById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/osxconfigurationprofiles/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/osxconfigurationprofiles/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/osxconfigurationprofiles/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/osxconfigurationprofiles/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/osxconfigurationprofiles/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/osxconfigurationprofiles/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/osxconfigurationprofiles/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /osxconfigurationprofiles/id/{id}
Deletes a OS X configuration profile by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findOsxConfigurationProfilesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/osxconfigurationprofiles/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/osxconfigurationprofiles/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/osxconfigurationprofiles/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/osxconfigurationprofiles/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/osxconfigurationprofiles/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/osxconfigurationprofiles/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/osxconfigurationprofiles/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /osxconfigurationprofiles/name/{name}
Finds OS X configuration profiles by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<description>string</description>
<site>
<id>0</id>
<name>string</name>
</site>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<distribution_method>string</distribution_method>
<user_removable>true</user_removable>
<level>computer</level>
<uuid>string</uuid>
<redeploy_on_update>string</redeploy_on_update>
<payloads>string</payloads>
</general>
updateOsxConfigurationProfileByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/osxconfigurationprofiles/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/osxconfigurationprofiles/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/osxconfigurationprofiles/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/osxconfigurationprofiles/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/osxconfigurationprofiles/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/osxconfigurationprofiles/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/osxconfigurationprofiles/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /osxconfigurationprofiles/name/{name}
Updates an existing OS X configuration profile by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteOsxConfigurationProfileByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/osxconfigurationprofiles/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/osxconfigurationprofiles/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/osxconfigurationprofiles/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/osxconfigurationprofiles/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/osxconfigurationprofiles/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/osxconfigurationprofiles/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/osxconfigurationprofiles/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /osxconfigurationprofiles/name/{name}
Deletes a OS X configuration profile by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findOsxConfigurationProfilesByIdSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/osxconfigurationprofiles/id/{id}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/osxconfigurationprofiles/id/{id}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/osxconfigurationprofiles/id/{id}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/osxconfigurationprofiles/id/{id}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/osxconfigurationprofiles/id/{id}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/osxconfigurationprofiles/id/{id}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/osxconfigurationprofiles/id/{id}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /osxconfigurationprofiles/id/{id}/subset/{subset}
Display subsets of information for an OS X configuration profile
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID to filter by |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | General |
| subset | Scope |
| subset | SelfService |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findPackages
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/packages \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/packages HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/packages',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/packages',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/packages', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/packages', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/packages");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /packages
Finds all packages
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<package>
<id>0</id>
<name>string</name>
</package>
findPackagesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/packages/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/packages/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/packages/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/packages/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/packages/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/packages/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/packages/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /packages/id/{id}
Finds packages by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<category>string</category>
<filename>string</filename>
<info>string</info>
<notes>string</notes>
<priority>0</priority>
<reboot_required>true</reboot_required>
<fill_user_template>true</fill_user_template>
<fill_existing_users>true</fill_existing_users>
<boot_volume_required>true</boot_volume_required>
<allow_uninstalled>true</allow_uninstalled>
<os_requirements>string</os_requirements>
<required_processor>None</required_processor>
<switch_with_package>string</switch_with_package>
<install_if_reported_available>true</install_if_reported_available>
<reinstall_option>string</reinstall_option>
<triggering_files>string</triggering_files>
<send_notification>true</send_notification>
updatePackageById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/packages/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/packages/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/packages/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"category": "string",
"filename": "string",
"info": "string",
"notes": "string",
"priority": 0,
"reboot_required": true,
"fill_user_template": true,
"fill_existing_users": true,
"boot_volume_required": true,
"allow_uninstalled": true,
"os_requirements": "string",
"required_processor": "None",
"switch_with_package": "string",
"install_if_reported_available": true,
"reinstall_option": "string",
"triggering_files": "string",
"send_notification": true
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/packages/id/{id}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/packages/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/packages/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/packages/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /packages/id/{id}
Updates an existing package by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | package | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<category>string</category>
<filename>string</filename>
<info>string</info>
<notes>string</notes>
<priority>0</priority>
<reboot_required>true</reboot_required>
<fill_user_template>true</fill_user_template>
<fill_existing_users>true</fill_existing_users>
<boot_volume_required>true</boot_volume_required>
<allow_uninstalled>true</allow_uninstalled>
<os_requirements>string</os_requirements>
<required_processor>None</required_processor>
<switch_with_package>string</switch_with_package>
<install_if_reported_available>true</install_if_reported_available>
<reinstall_option>string</reinstall_option>
<triggering_files>string</triggering_files>
<send_notification>true</send_notification>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createPackageById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/packages/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/packages/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/packages/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/packages/id/{id}',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/packages/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/packages/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/packages/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /packages/id/{id}
Creates a new package by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deletePackageById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/packages/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/packages/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/packages/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/packages/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/packages/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/packages/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/packages/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /packages/id/{id}
Deletes a package by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findPackagesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/packages/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/packages/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/packages/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/packages/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/packages/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/packages/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/packages/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /packages/name/{name}
Finds packages by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<category>string</category>
<filename>string</filename>
<info>string</info>
<notes>string</notes>
<priority>0</priority>
<reboot_required>true</reboot_required>
<fill_user_template>true</fill_user_template>
<fill_existing_users>true</fill_existing_users>
<boot_volume_required>true</boot_volume_required>
<allow_uninstalled>true</allow_uninstalled>
<os_requirements>string</os_requirements>
<required_processor>None</required_processor>
<switch_with_package>string</switch_with_package>
<install_if_reported_available>true</install_if_reported_available>
<reinstall_option>string</reinstall_option>
<triggering_files>string</triggering_files>
<send_notification>true</send_notification>
updatePackageByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/packages/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/packages/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/packages/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/packages/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/packages/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/packages/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/packages/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /packages/name/{name}
Updates an existing package by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deletePackageByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/packages/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/packages/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/packages/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/packages/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/packages/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/packages/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/packages/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /packages/name/{name}
Deletes a package by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findPatches
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/patches \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/patches HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/patches',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/patches',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/patches', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/patches', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/patches");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /patches
Finds all patches
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<patch_reporting_software_title>
<id>0</id>
<name>string</name>
</patch_reporting_software_title>
findPatchesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/patches/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/patches/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/patches/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/patches/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/patches/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/patches/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/patches/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /patches/id/{id}
Finds patches by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<notifications>
<jss_notification>true</jss_notification>
<email_notification>true</email_notification>
</notifications>
<total_versions>0</total_versions>
<total_computers>0</total_computers>
updateSoftwareTitlesById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/patches/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/patches/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/patches/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/patches/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/patches/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/patches/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/patches/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /patches/id/{id}
Updates a Patch Software Title by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to update by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteSoftwareTitlesById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/patches/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/patches/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/patches/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/patches/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/patches/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/patches/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/patches/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /patches/id/{id}
Deletes a Patch Software Title by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findPatchesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/patches/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/patches/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/patches/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/patches/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/patches/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/patches/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/patches/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /patches/name/{name}
Finds the first patch with the name provided
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<notifications>
<jss_notification>true</jss_notification>
<email_notification>true</email_notification>
</notifications>
<total_versions>0</total_versions>
<total_computers>0</total_computers>
updateSoftwareTitlesByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/patches/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/patches/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/patches/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/patches/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/patches/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/patches/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/patches/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /patches/name/{name}
Updates a Patch Software Title by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to update by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteSoftwareTitlesByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/patches/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/patches/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/patches/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/patches/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/patches/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/patches/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/patches/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /patches/name/{name}
Deletes a Patch Software Title by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findComputersByTitleVersion
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/patches/id/{id}/version/{version} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/patches/id/{id}/version/{version} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/patches/id/{id}/version/{version}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/patches/id/{id}/version/{version}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/patches/id/{id}/version/{version}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/patches/id/{id}/version/{version}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/patches/id/{id}/version/{version}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /patches/id/{id}/version/{version}
Display computers on a specific version
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID to filter by |
| version | path | string | true | Version number to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findPeripherals
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/peripherals \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/peripherals HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/peripherals',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/peripherals',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/peripherals', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/peripherals', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/peripherals");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /peripherals
Finds all peripherals
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<peripheral>
<id>0</id>
<name>string</name>
<type>string</type>
<bar_code_1>string</bar_code_1>
<bar_code_2>string</bar_code_2>
<computer_id>0</computer_id>
</peripheral>
findPeripheralsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/peripherals/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/peripherals/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/peripherals/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/peripherals/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/peripherals/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/peripherals/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/peripherals/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /peripherals/id/{id}
Finds peripherals by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<bar_code_1>string</bar_code_1>
<bar_code_2>string</bar_code_2>
<type>string</type>
<fields>
<field>
<name>string</name>
<value>string</value>
</field>
</fields>
</general>
<location>
<username>string</username>
<realname>string</realname>
<real_name>string</real_name>
<email_address>string</email_address>
<position>string</position>
<phone>string</phone>
<phone_number>string</phone_number>
<department>string</department>
<building>string</building>
<room>string</room>
</location>
<purchasing>
<is_purchased>true</is_purchased>
<is_leased>true</is_leased>
<po_number>string</po_number>
<vendor>string</vendor>
<applecare_id>string</applecare_id>
<purchase_price>string</purchase_price>
<purchasing_account>string</purchasing_account>
<po_date>string</po_date>
<po_date_epoch>0</po_date_epoch>
<po_date_utc>string</po_date_utc>
<warranty_expires>string</warranty_expires>
<warranty_expires_epoch>0</warranty_expires_epoch>
<warranty_expires_utc>string</warranty_expires_utc>
<lease_expires>string</lease_expires>
<lease_expires_epoch>0</lease_expires_epoch>
<lease_expires_utc>string</lease_expires_utc>
<life_expectancy>0</life_expectancy>
<purchasing_contact>string</purchasing_contact>
</purchasing>
<attachments>
<attachment>
<id>0</id>
<filename>string</filename>
<uri>string</uri>
</attachment>
</attachments>
updatePeripheralById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/peripherals/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/peripherals/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/peripherals/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/peripherals/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/peripherals/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/peripherals/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/peripherals/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /peripherals/id/{id}
Updates an existing peripheral by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createPeripheralById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/peripherals/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/peripherals/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/peripherals/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"id": 0,
"bar_code_1": "string",
"bar_code_2": "string",
"type": "string",
"fields": {
"field": {
"name": "string",
"value": "string"
}
}
},
"location": {
"username": "string",
"realname": "string",
"real_name": "string",
"email_address": "string",
"position": "string",
"phone": "string",
"phone_number": "string",
"department": "string",
"building": "string",
"room": "string"
},
"purchasing": {
"is_purchased": true,
"is_leased": true,
"po_number": "string",
"vendor": "string",
"applecare_id": "string",
"purchase_price": "string",
"purchasing_account": "string",
"po_date": "string",
"po_date_epoch": 0,
"po_date_utc": "string",
"warranty_expires": "string",
"warranty_expires_epoch": 0,
"warranty_expires_utc": "string",
"lease_expires": "string",
"lease_expires_epoch": 0,
"lease_expires_utc": "string",
"life_expectancy": 0,
"purchasing_contact": "string"
},
"attachments": {
"attachment": {
"id": 0,
"filename": "string",
"uri": "string"
}
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/peripherals/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/peripherals/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/peripherals/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/peripherals/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /peripherals/id/{id}
Creates a new peripheral by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | peripheral | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<bar_code_1>string</bar_code_1>
<bar_code_2>string</bar_code_2>
<type>string</type>
<fields>
<field>
<name>string</name>
<value>string</value>
</field>
</fields>
</general>
<location>
<username>string</username>
<realname>string</realname>
<real_name>string</real_name>
<email_address>string</email_address>
<position>string</position>
<phone>string</phone>
<phone_number>string</phone_number>
<department>string</department>
<building>string</building>
<room>string</room>
</location>
<purchasing>
<is_purchased>true</is_purchased>
<is_leased>true</is_leased>
<po_number>string</po_number>
<vendor>string</vendor>
<applecare_id>string</applecare_id>
<purchase_price>string</purchase_price>
<purchasing_account>string</purchasing_account>
<po_date>string</po_date>
<po_date_epoch>0</po_date_epoch>
<po_date_utc>string</po_date_utc>
<warranty_expires>string</warranty_expires>
<warranty_expires_epoch>0</warranty_expires_epoch>
<warranty_expires_utc>string</warranty_expires_utc>
<lease_expires>string</lease_expires>
<lease_expires_epoch>0</lease_expires_epoch>
<lease_expires_utc>string</lease_expires_utc>
<life_expectancy>0</life_expectancy>
<purchasing_contact>string</purchasing_contact>
</purchasing>
<attachments>
<attachment>
<id>0</id>
<filename>string</filename>
<uri>string</uri>
</attachment>
</attachments>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deletePeripheralById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/peripherals/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/peripherals/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/peripherals/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/peripherals/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/peripherals/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/peripherals/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/peripherals/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /peripherals/id/{id}
Deletes a peripheral by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findPeripheralsByIdSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/peripherals/id/{id}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/peripherals/id/{id}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/peripherals/id/{id}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/peripherals/id/{id}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/peripherals/id/{id}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/peripherals/id/{id}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/peripherals/id/{id}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /peripherals/id/{id}/subset/{subset}
Display subsets of information for a peripheral
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID to filter by |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | General |
| subset | Location |
| subset | Purchasing |
| subset | Attachments |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findPeripheralTypes
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/peripheraltypes \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/peripheraltypes HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/peripheraltypes',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/peripheraltypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/peripheraltypes', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/peripheraltypes', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/peripheraltypes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /peripheraltypes
Finds all peripheral types
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findPeripheralTypesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/peripheraltypes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/peripheraltypes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/peripheraltypes/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/peripheraltypes/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/peripheraltypes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/peripheraltypes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/peripheraltypes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /peripheraltypes/id/{id}
Finds peripheral types by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<fields>
<field>
<name>string</name>
<order>0</order>
<type>menu</type>
<choices>
<choice>string</choice>
</choices>
</field>
</fields>
updatePeripheralTypeById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/peripheraltypes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/peripheraltypes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/peripheraltypes/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/peripheraltypes/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/peripheraltypes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/peripheraltypes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/peripheraltypes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /peripheraltypes/id/{id}
Updates an existing peripheral by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createPeripheralTypeById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/peripheraltypes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/peripheraltypes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/peripheraltypes/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"fields": {
"field": {
"name": "string",
"order": 0,
"type": "menu",
"choices": {
"choice": "string"
}
}
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/peripheraltypes/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/peripheraltypes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/peripheraltypes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/peripheraltypes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /peripheraltypes/id/{id}
Creates a new peripheral by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | peripheral_type | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<fields>
<field>
<name>string</name>
<order>0</order>
<type>menu</type>
<choices>
<choice>string</choice>
</choices>
</field>
</fields>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deletePeripheralTypeById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/peripheraltypes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/peripheraltypes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/peripheraltypes/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/peripheraltypes/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/peripheraltypes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/peripheraltypes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/peripheraltypes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /peripheraltypes/id/{id}
Deletes a peripheral by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findPolicies
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/policies \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/policies HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/policies',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/policies',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/policies', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/policies', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/policies");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /policies
Finds all policies
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findPoliciesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/policies/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/policies/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/policies/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/policies/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/policies/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/policies/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/policies/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /policies/id/{id}
Finds policies by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<enabled>true</enabled>
<trigger>string</trigger>
<trigger_checkin>true</trigger_checkin>
<trigger_enrollment_complete>true</trigger_enrollment_complete>
<trigger_login>true</trigger_login>
<trigger_logout>true</trigger_logout>
<trigger_network_state_changed>true</trigger_network_state_changed>
<trigger_startup>true</trigger_startup>
<trigger_other>string</trigger_other>
<frequency>Once per computer</frequency>
<location_user_only>true</location_user_only>
<target_drive>string</target_drive>
<offline>true</offline>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<date_time_limitations>
<activation_date>string</activation_date>
<activation_date_epoch>0</activation_date_epoch>
<activation_date_utc>string</activation_date_utc>
<expiration_date>string</expiration_date>
<expiration_date_epoch>0</expiration_date_epoch>
<expiration_date_utc>string</expiration_date_utc>
<no_execute_on>
<day>Sun</day>
</no_execute_on>
<no_execute_start>string</no_execute_start>
<no_execute_end>string</no_execute_end>
</date_time_limitations>
<network_limitations>
<minimum_network_connection>No Minimum</minimum_network_connection>
<any_ip_address>true</any_ip_address>
</network_limitations>
<override_default_settings>
<target_drive>string</target_drive>
<distribution_point>string</distribution_point>
<force_afp_smb>true</force_afp_smb>
<sus>string</sus>
<netboot_server>string</netboot_server>
</override_default_settings>
<network_requirements>Any</network_requirements>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
updatePolicyById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/policies/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/policies/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/policies/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/policies/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/policies/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/policies/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/policies/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /policies/id/{id}
Updates an existing policy by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createPolicyById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/policies/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/policies/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/policies/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"id": 0,
"name": "string",
"enabled": true,
"trigger": "string",
"trigger_checkin": true,
"trigger_enrollment_complete": true,
"trigger_login": true,
"trigger_logout": true,
"trigger_network_state_changed": true,
"trigger_startup": true,
"trigger_other": "string",
"frequency": "Once per computer",
"location_user_only": true,
"target_drive": "string",
"offline": true,
"category": {
"id": 0,
"name": "Category name",
"priority": 9
},
"date_time_limitations": {
"activation_date": "string",
"activation_date_epoch": 0,
"activation_date_utc": "string",
"expiration_date": "string",
"expiration_date_epoch": 0,
"expiration_date_utc": "string",
"no_execute_on": {
"day": "Sun"
},
"no_execute_start": "string",
"no_execute_end": "string"
},
"network_limitations": {
"minimum_network_connection": "No Minimum",
"any_ip_address": true
},
"override_default_settings": {
"target_drive": "string",
"distribution_point": "string",
"force_afp_smb": true,
"sus": "string",
"netboot_server": "string"
},
"network_requirements": "Any",
"site": {
"id": 0,
"name": "string"
}
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/policies/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/policies/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/policies/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/policies/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /policies/id/{id}
Creates a new policy by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | policy | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<enabled>true</enabled>
<trigger>string</trigger>
<trigger_checkin>true</trigger_checkin>
<trigger_enrollment_complete>true</trigger_enrollment_complete>
<trigger_login>true</trigger_login>
<trigger_logout>true</trigger_logout>
<trigger_network_state_changed>true</trigger_network_state_changed>
<trigger_startup>true</trigger_startup>
<trigger_other>string</trigger_other>
<frequency>Once per computer</frequency>
<location_user_only>true</location_user_only>
<target_drive>string</target_drive>
<offline>true</offline>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<date_time_limitations>
<activation_date>string</activation_date>
<activation_date_epoch>0</activation_date_epoch>
<activation_date_utc>string</activation_date_utc>
<expiration_date>string</expiration_date>
<expiration_date_epoch>0</expiration_date_epoch>
<expiration_date_utc>string</expiration_date_utc>
<no_execute_on>
<day>Sun</day>
</no_execute_on>
<no_execute_start>string</no_execute_start>
<no_execute_end>string</no_execute_end>
</date_time_limitations>
<network_limitations>
<minimum_network_connection>No Minimum</minimum_network_connection>
<any_ip_address>true</any_ip_address>
</network_limitations>
<override_default_settings>
<target_drive>string</target_drive>
<distribution_point>string</distribution_point>
<force_afp_smb>true</force_afp_smb>
<sus>string</sus>
<netboot_server>string</netboot_server>
</override_default_settings>
<network_requirements>Any</network_requirements>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deletePolicyById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/policies/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/policies/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/policies/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/policies/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/policies/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/policies/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/policies/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /policies/id/{id}
Deletes a policy by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findPoliciesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/policies/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/policies/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/policies/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/policies/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/policies/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/policies/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/policies/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /policies/name/{name}
Finds policies by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<enabled>true</enabled>
<trigger>string</trigger>
<trigger_checkin>true</trigger_checkin>
<trigger_enrollment_complete>true</trigger_enrollment_complete>
<trigger_login>true</trigger_login>
<trigger_logout>true</trigger_logout>
<trigger_network_state_changed>true</trigger_network_state_changed>
<trigger_startup>true</trigger_startup>
<trigger_other>string</trigger_other>
<frequency>Once per computer</frequency>
<location_user_only>true</location_user_only>
<target_drive>string</target_drive>
<offline>true</offline>
<category>
<id>0</id>
<name>Category name</name>
<priority>9</priority>
</category>
<date_time_limitations>
<activation_date>string</activation_date>
<activation_date_epoch>0</activation_date_epoch>
<activation_date_utc>string</activation_date_utc>
<expiration_date>string</expiration_date>
<expiration_date_epoch>0</expiration_date_epoch>
<expiration_date_utc>string</expiration_date_utc>
<no_execute_on>
<day>Sun</day>
</no_execute_on>
<no_execute_start>string</no_execute_start>
<no_execute_end>string</no_execute_end>
</date_time_limitations>
<network_limitations>
<minimum_network_connection>No Minimum</minimum_network_connection>
<any_ip_address>true</any_ip_address>
</network_limitations>
<override_default_settings>
<target_drive>string</target_drive>
<distribution_point>string</distribution_point>
<force_afp_smb>true</force_afp_smb>
<sus>string</sus>
<netboot_server>string</netboot_server>
</override_default_settings>
<network_requirements>Any</network_requirements>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
updatePolicyByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/policies/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/policies/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/policies/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/policies/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/policies/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/policies/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/policies/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /policies/name/{name}
Updates an existing policy by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deletePolicyByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/policies/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/policies/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/policies/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/policies/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/policies/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/policies/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/policies/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /policies/name/{name}
Deletes a policy by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findPoliciesByIdSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/policies/id/{id}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/policies/id/{id}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/policies/id/{id}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/policies/id/{id}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/policies/id/{id}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/policies/id/{id}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/policies/id/{id}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /policies/id/{id}/subset/{subset}
Display subsets of information for a policy
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID to filter by |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | General |
| subset | Scope |
| subset | SelfService |
| subset | PackageConfiguration |
| subset | Scripts |
| subset | Printers |
| subset | DockItems |
| subset | AccountMaintenance |
| subset | Reboot |
| subset | Maintenance |
| subset | FilesProcesses |
| subset | UserInteraction |
| subset | DiskEncryption |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findPoliciesByCategory
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/policies/category/{category} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/policies/category/{category} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/policies/category/{category}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/policies/category/{category}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/policies/category/{category}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/policies/category/{category}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/policies/category/{category}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /policies/category/{category}
Finds all policies by category
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| category | path | string | true | Category to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findPoliciesByType
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/policies/createdBy/{createdBy} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/policies/createdBy/{createdBy} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/policies/createdBy/{createdBy}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/policies/createdBy/{createdBy}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/policies/createdBy/{createdBy}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/policies/createdBy/{createdBy}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/policies/createdBy/{createdBy}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /policies/createdBy/{createdBy}
Finds all policies by type
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| createdBy | path | string | true | Type to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| createdBy | jss |
| createdBy | casper |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findPrinters
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/printers \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/printers HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/printers',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/printers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/printers', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/printers', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/printers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /printers
Finds all printers
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findPrintersById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/printers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/printers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/printers/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/printers/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/printers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/printers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/printers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /printers/id/{id}
Finds printers by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<category>string</category>
<uri>string</uri>
<CUPS_name>string</CUPS_name>
<location>string</location>
<model>string</model>
<info>string</info>
<notes>string</notes>
<make_default>true</make_default>
<use_generic>true</use_generic>
<ppd>string</ppd>
<ppd_contents>string</ppd_contents>
updatePrinterById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/printers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/printers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/printers/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/printers/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/printers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/printers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/printers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /printers/id/{id}
Updates an existing printer by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createPrinterById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/printers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/printers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/printers/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"category": "string",
"uri": "string",
"CUPS_name": "string",
"location": "string",
"model": "string",
"info": "string",
"notes": "string",
"make_default": true,
"use_generic": true,
"ppd": "string",
"ppd_contents": "string"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/printers/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/printers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/printers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/printers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /printers/id/{id}
Creates a new printer by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | printer | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<category>string</category>
<uri>string</uri>
<CUPS_name>string</CUPS_name>
<location>string</location>
<model>string</model>
<info>string</info>
<notes>string</notes>
<make_default>true</make_default>
<use_generic>true</use_generic>
<ppd>string</ppd>
<ppd_contents>string</ppd_contents>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deletePrinterById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/printers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/printers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/printers/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/printers/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/printers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/printers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/printers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /printers/id/{id}
Deletes a printer by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findPrintersByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/printers/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/printers/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/printers/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/printers/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/printers/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/printers/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/printers/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /printers/name/{name}
Finds printers by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<category>string</category>
<uri>string</uri>
<CUPS_name>string</CUPS_name>
<location>string</location>
<model>string</model>
<info>string</info>
<notes>string</notes>
<make_default>true</make_default>
<use_generic>true</use_generic>
<ppd>string</ppd>
<ppd_contents>string</ppd_contents>
updatePrinterByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/printers/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/printers/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/printers/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/printers/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/printers/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/printers/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/printers/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /printers/name/{name}
Updates an existing printer by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deletePrinterByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/printers/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/printers/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/printers/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/printers/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/printers/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/printers/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/printers/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /printers/name/{name}
Deletes a printer by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findRemovableMacAddresses
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/removablemacaddresses \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/removablemacaddresses HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/removablemacaddresses',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/removablemacaddresses',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/removablemacaddresses', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/removablemacaddresses', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/removablemacaddresses");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /removablemacaddresses
Finds all removable Mac addresses
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findRemovableMacAddressesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/removablemacaddresses/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/removablemacaddresses/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/removablemacaddresses/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/removablemacaddresses/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/removablemacaddresses/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/removablemacaddresses/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/removablemacaddresses/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /removablemacaddresses/id/{id}
Finds removable Mac addresses by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
updateRemovableMacAddressById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/removablemacaddresses/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/removablemacaddresses/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/removablemacaddresses/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/removablemacaddresses/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/removablemacaddresses/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/removablemacaddresses/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/removablemacaddresses/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /removablemacaddresses/id/{id}
Updates an existing removable Mac address by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createRemovableMacAddressById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/removablemacaddresses/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/removablemacaddresses/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/removablemacaddresses/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/removablemacaddresses/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/removablemacaddresses/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/removablemacaddresses/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/removablemacaddresses/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /removablemacaddresses/id/{id}
Creates a new removable Mac address by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | removable_mac_address | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>
<type>integer</type>
</id>
<name>
<type>string</type>
</name>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteRemovableMacAddressById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/removablemacaddresses/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/removablemacaddresses/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/removablemacaddresses/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/removablemacaddresses/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/removablemacaddresses/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/removablemacaddresses/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/removablemacaddresses/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /removablemacaddresses/id/{id}
Deletes a removable Mac address by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findRemovableMacAddressesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/removablemacaddresses/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/removablemacaddresses/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/removablemacaddresses/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/removablemacaddresses/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/removablemacaddresses/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/removablemacaddresses/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/removablemacaddresses/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /removablemacaddresses/name/{name}
Finds removable Mac addresses by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
updateRemovableMacAddressByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/removablemacaddresses/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/removablemacaddresses/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/removablemacaddresses/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/removablemacaddresses/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/removablemacaddresses/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/removablemacaddresses/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/removablemacaddresses/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /removablemacaddresses/name/{name}
Updates an existing removable Mac address by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteRemovableMacAddressByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/removablemacaddresses/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/removablemacaddresses/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/removablemacaddresses/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/removablemacaddresses/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/removablemacaddresses/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/removablemacaddresses/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/removablemacaddresses/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /removablemacaddresses/name/{name}
Deletes a removable Mac address by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findRestrictedSoftware
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/restrictedsoftware \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/restrictedsoftware HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/restrictedsoftware',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/restrictedsoftware',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/restrictedsoftware', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/restrictedsoftware', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/restrictedsoftware");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /restrictedsoftware
Finds all restricted software
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<restricted_software/>
findRestrictedSoftwareById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/restrictedsoftware/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/restrictedsoftware/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/restrictedsoftware/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/restrictedsoftware/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/restrictedsoftware/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/restrictedsoftware/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/restrictedsoftware/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /restrictedsoftware/id/{id}
Finds restricted software by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<process_name>string</process_name>
<match_exact_process_name>true</match_exact_process_name>
<send_notification>true</send_notification>
<kill_process>true</kill_process>
<delete_executable>true</delete_executable>
<display_message>string</display_message>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
updateRestrictedSoftwareById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/restrictedsoftware/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/restrictedsoftware/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/restrictedsoftware/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/restrictedsoftware/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/restrictedsoftware/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/restrictedsoftware/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/restrictedsoftware/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /restrictedsoftware/id/{id}
Updates an existing restricted software by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createRestrictedSoftwareById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/restrictedsoftware/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/restrictedsoftware/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/restrictedsoftware/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"id": 0,
"name": "string",
"process_name": "string",
"match_exact_process_name": true,
"send_notification": true,
"kill_process": true,
"delete_executable": true,
"display_message": "string",
"site": {
"id": 0,
"name": "string"
}
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/restrictedsoftware/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/restrictedsoftware/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/restrictedsoftware/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/restrictedsoftware/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /restrictedsoftware/id/{id}
Creates a new restricted software by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | restricted_software | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<process_name>string</process_name>
<match_exact_process_name>true</match_exact_process_name>
<send_notification>true</send_notification>
<kill_process>true</kill_process>
<delete_executable>true</delete_executable>
<display_message>string</display_message>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteRestrictedSoftwareById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/restrictedsoftware/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/restrictedsoftware/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/restrictedsoftware/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/restrictedsoftware/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/restrictedsoftware/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/restrictedsoftware/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/restrictedsoftware/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /restrictedsoftware/id/{id}
Deletes a restricted software by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findRestrictedSoftwareByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/restrictedsoftware/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/restrictedsoftware/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/restrictedsoftware/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/restrictedsoftware/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/restrictedsoftware/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/restrictedsoftware/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/restrictedsoftware/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /restrictedsoftware/name/{name}
Finds restricted software by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<process_name>string</process_name>
<match_exact_process_name>true</match_exact_process_name>
<send_notification>true</send_notification>
<kill_process>true</kill_process>
<delete_executable>true</delete_executable>
<display_message>string</display_message>
<site>
<id>0</id>
<name>string</name>
</site>
</general>
updateRestrictedSoftwareByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/restrictedsoftware/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/restrictedsoftware/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/restrictedsoftware/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/restrictedsoftware/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/restrictedsoftware/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/restrictedsoftware/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/restrictedsoftware/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /restrictedsoftware/name/{name}
Updates an existing restricted software by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteRestrictedSoftwareByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/restrictedsoftware/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/restrictedsoftware/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/restrictedsoftware/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/restrictedsoftware/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/restrictedsoftware/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/restrictedsoftware/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/restrictedsoftware/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /restrictedsoftware/name/{name}
Deletes a restricted software by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findScripts
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/scripts \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/scripts HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/scripts',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/scripts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/scripts', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/scripts', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/scripts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /scripts
Finds all scripts
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findScriptsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/scripts/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/scripts/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/scripts/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/scripts/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/scripts/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/scripts/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/scripts/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /scripts/id/{id}
Finds scripts by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<category>string</category>
<filename>string</filename>
<info>string</info>
<notes>string</notes>
<priority>Before</priority>
<parameters>
<parameter4>string</parameter4>
<parameter5>string</parameter5>
<parameter6>string</parameter6>
<parameter7>string</parameter7>
<parameter8>string</parameter8>
<parameter9>string</parameter9>
<parameter10>string</parameter10>
<parameter11>string</parameter11>
</parameters>
<os_requirements>string</os_requirements>
<script_contents>string</script_contents>
<script_contents_encoded>string</script_contents_encoded>
updateScriptById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/scripts/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/scripts/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/scripts/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/scripts/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/scripts/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/scripts/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/scripts/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /scripts/id/{id}
Updates an existing script by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createScriptById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/scripts/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/scripts/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/scripts/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"category": "string",
"filename": "string",
"info": "string",
"notes": "string",
"priority": "Before",
"parameters": {
"parameter4": "string",
"parameter5": "string",
"parameter6": "string",
"parameter7": "string",
"parameter8": "string",
"parameter9": "string",
"parameter10": "string",
"parameter11": "string"
},
"os_requirements": "string",
"script_contents": "string",
"script_contents_encoded": "string"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/scripts/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/scripts/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/scripts/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/scripts/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /scripts/id/{id}
Creates a new script by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | script | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<category>string</category>
<filename>string</filename>
<info>string</info>
<notes>string</notes>
<priority>Before</priority>
<parameters>
<parameter4>string</parameter4>
<parameter5>string</parameter5>
<parameter6>string</parameter6>
<parameter7>string</parameter7>
<parameter8>string</parameter8>
<parameter9>string</parameter9>
<parameter10>string</parameter10>
<parameter11>string</parameter11>
</parameters>
<os_requirements>string</os_requirements>
<script_contents>string</script_contents>
<script_contents_encoded>string</script_contents_encoded>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteScriptById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/scripts/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/scripts/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/scripts/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/scripts/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/scripts/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/scripts/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/scripts/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /scripts/id/{id}
Deletes a script by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findScriptsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/scripts/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/scripts/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/scripts/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/scripts/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/scripts/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/scripts/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/scripts/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /scripts/name/{name}
Finds scripts by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<category>string</category>
<filename>string</filename>
<info>string</info>
<notes>string</notes>
<priority>Before</priority>
<parameters>
<parameter4>string</parameter4>
<parameter5>string</parameter5>
<parameter6>string</parameter6>
<parameter7>string</parameter7>
<parameter8>string</parameter8>
<parameter9>string</parameter9>
<parameter10>string</parameter10>
<parameter11>string</parameter11>
</parameters>
<os_requirements>string</os_requirements>
<script_contents>string</script_contents>
<script_contents_encoded>string</script_contents_encoded>
updateScriptByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/scripts/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/scripts/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/scripts/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/scripts/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/scripts/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/scripts/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/scripts/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /scripts/name/{name}
Updates an existing script by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteScriptByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/scripts/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/scripts/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/scripts/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/scripts/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/scripts/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/scripts/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/scripts/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /scripts/name/{name}
Deletes a script by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findSites
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/sites \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/sites HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/sites',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/sites',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/sites', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/sites', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/sites");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /sites
Finds all sites
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findSitesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/sites/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/sites/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/sites/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/sites/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/sites/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/sites/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/sites/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /sites/id/{id}
Finds sites by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
updateSiteById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/sites/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/sites/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/sites/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/sites/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/sites/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/sites/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/sites/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /sites/id/{id}
Updates an existing site by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createSiteById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/sites/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/sites/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/sites/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/sites/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/sites/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/sites/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/sites/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /sites/id/{id}
Creates a new site by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | site | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteSiteById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/sites/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/sites/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/sites/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/sites/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/sites/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/sites/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/sites/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /sites/id/{id}
Deletes a site by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findSitesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/sites/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/sites/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/sites/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/sites/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/sites/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/sites/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/sites/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /sites/name/{name}
Finds sites by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
updateSiteByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/sites/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/sites/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/sites/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/sites/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/sites/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/sites/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/sites/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /sites/name/{name}
Updates an existing site by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteSiteByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/sites/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/sites/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/sites/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/sites/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/sites/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/sites/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/sites/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /sites/name/{name}
Deletes a site by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findSMTPServer
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/smtpserver \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/smtpserver HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/smtpserver',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/smtpserver',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/smtpserver', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/smtpserver', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/smtpserver");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /smtpserver
Finds the JSS SMTP server information
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<enabled>true</enabled>
<host>string</host>
<port>0</port>
<timeout>0</timeout>
<authorization_required>true</authorization_required>
<username>string</username>
<password>string</password>
<ssl>true</ssl>
<tls>true</tls>
<send_from_name>string</send_from_name>
<send_from_email>string</send_from_email>
updateSMTPServer
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/smtpserver \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/smtpserver HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/smtpserver',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/smtpserver',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/smtpserver', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/smtpserver', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/smtpserver");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /smtpserver
Updates the JSS SMTP server information
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
findSoftwareUpdateServers
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/softwareupdateservers \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/softwareupdateservers HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/softwareupdateservers',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/softwareupdateservers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/softwareupdateservers', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/softwareupdateservers', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/softwareupdateservers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /softwareupdateservers
Finds all software update servers
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findSoftwareUpdateServersById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/softwareupdateservers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/softwareupdateservers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/softwareupdateservers/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/softwareupdateservers/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/softwareupdateservers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/softwareupdateservers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/softwareupdateservers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /softwareupdateservers/id/{id}
Finds software update servers by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<ip_address>string</ip_address>
<port>0</port>
<set_system_wide>true</set_system_wide>
updateSoftwareUpdateServerById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/softwareupdateservers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/softwareupdateservers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/softwareupdateservers/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/softwareupdateservers/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/softwareupdateservers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/softwareupdateservers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/softwareupdateservers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /softwareupdateservers/id/{id}
Updates an existing software update server by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createSoftwareUpdateServerById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/softwareupdateservers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/softwareupdateservers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/softwareupdateservers/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"ip_address": "string",
"port": 0,
"set_system_wide": true
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/softwareupdateservers/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/softwareupdateservers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/softwareupdateservers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/softwareupdateservers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /softwareupdateservers/id/{id}
Creates a new software update server by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | software_update_server | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<ip_address>string</ip_address>
<port>0</port>
<set_system_wide>true</set_system_wide>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteSoftwareUpdateServerById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/softwareupdateservers/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/softwareupdateservers/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/softwareupdateservers/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/softwareupdateservers/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/softwareupdateservers/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/softwareupdateservers/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/softwareupdateservers/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /softwareupdateservers/id/{id}
Deletes a software update server by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findSoftwareUpdateServersByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/softwareupdateservers/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/softwareupdateservers/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/softwareupdateservers/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/softwareupdateservers/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/softwareupdateservers/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/softwareupdateservers/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/softwareupdateservers/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /softwareupdateservers/name/{name}
Finds software update servers by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<ip_address>string</ip_address>
<port>0</port>
<set_system_wide>true</set_system_wide>
updateSoftwareUpdateServerByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/softwareupdateservers/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/softwareupdateservers/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/softwareupdateservers/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/softwareupdateservers/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/softwareupdateservers/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/softwareupdateservers/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/softwareupdateservers/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /softwareupdateservers/name/{name}
Updates an existing software update server by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteSoftwareUpdateServerByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/softwareupdateservers/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/softwareupdateservers/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/softwareupdateservers/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/softwareupdateservers/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/softwareupdateservers/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/softwareupdateservers/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/softwareupdateservers/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /softwareupdateservers/name/{name}
Deletes a software update server by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findUserextensionattributes
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/userextensionattributes \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/userextensionattributes HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/userextensionattributes',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/userextensionattributes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/userextensionattributes', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/userextensionattributes', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/userextensionattributes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /userextensionattributes
Finds all user extension attributes
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findUserextensionattributesById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/userextensionattributes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/userextensionattributes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/userextensionattributes/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/userextensionattributes/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/userextensionattributes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/userextensionattributes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/userextensionattributes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /userextensionattributes/id/{id}
Finds user extension attributes by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<data_type>String</data_type>
<input_type>
<type>Text Field</type>
</input_type>
updateUserextensionattributeById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/userextensionattributes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/userextensionattributes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/userextensionattributes/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/userextensionattributes/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/userextensionattributes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/userextensionattributes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/userextensionattributes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /userextensionattributes/id/{id}
Updates an existing user extension attribute by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createUserextensionattributeById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/userextensionattributes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/userextensionattributes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/userextensionattributes/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"description": "string",
"data_type": "String",
"input_type": {
"type": "Text Field"
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/userextensionattributes/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/userextensionattributes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/userextensionattributes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/userextensionattributes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /userextensionattributes/id/{id}
Creates a new user extension attribute by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | user_extension_attribute | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<data_type>String</data_type>
<input_type>
<type>Text Field</type>
</input_type>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteUserextensionattributeById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/userextensionattributes/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/userextensionattributes/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/userextensionattributes/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/userextensionattributes/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/userextensionattributes/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/userextensionattributes/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/userextensionattributes/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /userextensionattributes/id/{id}
Deletes a user extension attribute by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findUserextensionattributesByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/userextensionattributes/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/userextensionattributes/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/userextensionattributes/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/userextensionattributes/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/userextensionattributes/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/userextensionattributes/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/userextensionattributes/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /userextensionattributes/name/{name}
Finds user extension attributes by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<data_type>String</data_type>
<input_type>
<type>Text Field</type>
</input_type>
updateUserextensionattributeByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/userextensionattributes/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/userextensionattributes/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/userextensionattributes/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/userextensionattributes/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/userextensionattributes/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/userextensionattributes/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/userextensionattributes/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /userextensionattributes/name/{name}
Updates an existing user extension attribute by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteUserextensionattributeByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/userextensionattributes/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/userextensionattributes/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/userextensionattributes/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/userextensionattributes/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/userextensionattributes/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/userextensionattributes/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/userextensionattributes/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /userextensionattributes/name/{name}
Deletes a user extension attribute by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findUserGroups
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/usergroups \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/usergroups HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/usergroups',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/usergroups',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/usergroups', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/usergroups', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/usergroups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /usergroups
Finds all user groups
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<user_group>
<id>0</id>
<name>string</name>
<is_smart>true</is_smart>
<is_notify_on_change>true</is_notify_on_change>
</user_group>
findUserGroupsById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/usergroups/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/usergroups/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/usergroups/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/usergroups/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/usergroups/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/usergroups/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/usergroups/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /usergroups/id/{id}
Finds user groups by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<is_smart>true</is_smart>
<is_notify_on_change>true</is_notify_on_change>
<site>
<id>0</id>
<name>string</name>
</site>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<users>
<user>
<id>0</id>
<username>string</username>
<full_name>string</full_name>
<phone_number>string</phone_number>
<email_address>string</email_address>
</user>
</users>
updateUserGroupsById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/usergroups/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/usergroups/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/usergroups/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/usergroups/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/usergroups/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/usergroups/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/usergroups/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /usergroups/id/{id}
Updates user groups by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createUserGroupsById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/usergroups/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/usergroups/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/usergroups/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"is_smart": true,
"is_notify_on_change": true,
"site": {
"id": 0,
"name": "string"
},
"criteria": {
"criterion": {
"name": "string",
"priority": 0,
"and_or": "and",
"search_type": "string",
"value": "string",
"opening_paren": true,
"closing_paren": true
}
},
"users": {
"user": {
"id": 0,
"username": "string",
"full_name": "string",
"phone_number": "string",
"email_address": "string"
}
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/usergroups/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/usergroups/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/usergroups/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/usergroups/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /usergroups/id/{id}
Creates user groups by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | user_group | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<is_smart>true</is_smart>
<is_notify_on_change>true</is_notify_on_change>
<site>
<id>0</id>
<name>string</name>
</site>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<users>
<user>
<id>0</id>
<username>string</username>
<full_name>string</full_name>
<phone_number>string</phone_number>
<email_address>string</email_address>
</user>
</users>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteUserGroupsById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/usergroups/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/usergroups/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/usergroups/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/usergroups/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/usergroups/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/usergroups/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/usergroups/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /usergroups/id/{id}
Deletes user groups by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findUserGroupsByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/usergroups/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/usergroups/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/usergroups/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/usergroups/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/usergroups/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/usergroups/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/usergroups/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /usergroups/name/{name}
Finds user groups by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<is_smart>true</is_smart>
<is_notify_on_change>true</is_notify_on_change>
<site>
<id>0</id>
<name>string</name>
</site>
<criteria>
<criterion>
<name>string</name>
<priority>0</priority>
<and_or>and</and_or>
<search_type>string</search_type>
<value>string</value>
<opening_paren>true</opening_paren>
<closing_paren>true</closing_paren>
</criterion>
</criteria>
<users>
<user>
<id>0</id>
<username>string</username>
<full_name>string</full_name>
<phone_number>string</phone_number>
<email_address>string</email_address>
</user>
</users>
updateUserGroupsByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/usergroups/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/usergroups/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/usergroups/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/usergroups/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/usergroups/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/usergroups/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/usergroups/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /usergroups/name/{name}
Updates user groups by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteUserGroupsByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/usergroups/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/usergroups/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/usergroups/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/usergroups/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/usergroups/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/usergroups/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/usergroups/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /usergroups/name/{name}
Deletes user groups by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findUsers
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/users \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/users HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/users',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/users',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/users', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/users', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /users
Finds all users
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findUsersById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/users/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/users/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/users/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/users/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/users/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/users/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/users/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /users/id/{id}
Finds users by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<full_name>string</full_name>
<email>string</email>
<email_address>string</email_address>
<phone_number>string</phone_number>
<position>string</position>
<enable_custom_photo_url>true</enable_custom_photo_url>
<custom_photo_url>string</custom_photo_url>
<ldap_server>
<id>0</id>
<name>string</name>
</ldap_server>
<extension_attributes>
<extension_attribute>
<id>0</id>
<name>string</name>
<type>String</type>
<value>string</value>
</extension_attribute>
</extension_attributes>
<sites>
<id>0</id>
<name>string</name>
</sites>
<links>
<computers>
<computer>
<id>0</id>
<name>string</name>
</computer>
</computers>
<peripherals>
<peripheral>
<id>0</id>
<name>string</name>
</peripheral>
</peripherals>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
</mobile_device>
</mobile_devices>
<vpp_assignments>
<vpp_assignment>
<id>0</id>
<name>string</name>
</vpp_assignment>
</vpp_assignments>
<total_vpp_code_count>0</total_vpp_code_count>
</links>
updateUserById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/users/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/users/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/users/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/users/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/users/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/users/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/users/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /users/id/{id}
Updates an existing user by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createUserById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/users/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/users/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/users/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"full_name": "string",
"email": "string",
"email_address": "string",
"phone_number": "string",
"position": "string",
"enable_custom_photo_url": true,
"custom_photo_url": "string",
"ldap_server": {
"id": 0,
"name": "string"
},
"extension_attributes": {
"extension_attribute": {
"id": 0,
"name": "string",
"type": "String",
"value": "string"
}
},
"sites": {
"id": 0,
"name": "string"
},
"links": {
"computers": {
"computer": {
"id": 0,
"name": "string"
}
},
"peripherals": {
"peripheral": {
"id": 0,
"name": "string"
}
},
"mobile_devices": {
"mobile_device": {
"id": 0,
"name": "string"
}
},
"vpp_assignments": {
"vpp_assignment": {
"id": 0,
"name": "string"
}
},
"total_vpp_code_count": 0
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/users/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/users/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/users/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/users/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /users/id/{id}
Creates a new user by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | user | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<full_name>string</full_name>
<email>string</email>
<email_address>string</email_address>
<phone_number>string</phone_number>
<position>string</position>
<enable_custom_photo_url>true</enable_custom_photo_url>
<custom_photo_url>string</custom_photo_url>
<ldap_server>
<id>0</id>
<name>string</name>
</ldap_server>
<extension_attributes>
<extension_attribute>
<id>0</id>
<name>string</name>
<type>String</type>
<value>string</value>
</extension_attribute>
</extension_attributes>
<sites>
<id>0</id>
<name>string</name>
</sites>
<links>
<computers>
<computer>
<id>0</id>
<name>string</name>
</computer>
</computers>
<peripherals>
<peripheral>
<id>0</id>
<name>string</name>
</peripheral>
</peripherals>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
</mobile_device>
</mobile_devices>
<vpp_assignments>
<vpp_assignment>
<id>0</id>
<name>string</name>
</vpp_assignment>
</vpp_assignments>
<total_vpp_code_count>0</total_vpp_code_count>
</links>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteUserById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/users/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/users/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/users/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/users/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/users/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/users/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/users/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /users/id/{id}
Deletes a user by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findUsersByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/users/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/users/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/users/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/users/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/users/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/users/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/users/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /users/name/{name}
Finds users by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<full_name>string</full_name>
<email>string</email>
<email_address>string</email_address>
<phone_number>string</phone_number>
<position>string</position>
<enable_custom_photo_url>true</enable_custom_photo_url>
<custom_photo_url>string</custom_photo_url>
<ldap_server>
<id>0</id>
<name>string</name>
</ldap_server>
<extension_attributes>
<extension_attribute>
<id>0</id>
<name>string</name>
<type>String</type>
<value>string</value>
</extension_attribute>
</extension_attributes>
<sites>
<id>0</id>
<name>string</name>
</sites>
<links>
<computers>
<computer>
<id>0</id>
<name>string</name>
</computer>
</computers>
<peripherals>
<peripheral>
<id>0</id>
<name>string</name>
</peripheral>
</peripherals>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
</mobile_device>
</mobile_devices>
<vpp_assignments>
<vpp_assignment>
<id>0</id>
<name>string</name>
</vpp_assignment>
</vpp_assignments>
<total_vpp_code_count>0</total_vpp_code_count>
</links>
updateUserByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/users/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/users/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/users/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/users/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/users/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/users/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/users/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /users/name/{name}
Updates an existing user by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteUserByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/users/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/users/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/users/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/users/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/users/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/users/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/users/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /users/name/{name}
Deletes a user by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findUsersByEmailAddress
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/users/email/{email} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/users/email/{email} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/users/email/{email}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/users/email/{email}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/users/email/{email}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/users/email/{email}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/users/email/{email}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /users/email/{email}
Finds users by email address
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| path | string | true | Email address to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<full_name>string</full_name>
<email>string</email>
<email_address>string</email_address>
<phone_number>string</phone_number>
<position>string</position>
<enable_custom_photo_url>true</enable_custom_photo_url>
<custom_photo_url>string</custom_photo_url>
<ldap_server>
<id>0</id>
<name>string</name>
</ldap_server>
<extension_attributes>
<extension_attribute>
<id>0</id>
<name>string</name>
<type>String</type>
<value>string</value>
</extension_attribute>
</extension_attributes>
<sites>
<id>0</id>
<name>string</name>
</sites>
<links>
<computers>
<computer>
<id>0</id>
<name>string</name>
</computer>
</computers>
<peripherals>
<peripheral>
<id>0</id>
<name>string</name>
</peripheral>
</peripherals>
<mobile_devices>
<mobile_device>
<id>0</id>
<name>string</name>
</mobile_device>
</mobile_devices>
<vpp_assignments>
<vpp_assignment>
<id>0</id>
<name>string</name>
</vpp_assignment>
</vpp_assignments>
<total_vpp_code_count>0</total_vpp_code_count>
</links>
updateUserByEmailAddress
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/users/email/{email} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/users/email/{email} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/users/email/{email}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/users/email/{email}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/users/email/{email}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/users/email/{email}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/users/email/{email}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /users/email/{email}
Updates an existing user by email address
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| path | string | true | Email address value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteUserByEmailAddress
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/users/email/{email} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/users/email/{email} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/users/email/{email}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/users/email/{email}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/users/email/{email}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/users/email/{email}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/users/email/{email}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /users/email/{email}
Deletes a user by email address
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| path | string | true | Email address value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findVPPAdminAccount
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/vppaccounts \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/vppaccounts HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/vppaccounts',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/vppaccounts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/vppaccounts', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/vppaccounts', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/vppaccounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /vppaccounts
Finds all VPP Accounts
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<vpp_account>
<id>0</id>
<name>string</name>
</vpp_account>
findVPPAdminAccountById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/vppaccounts/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/vppaccounts/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/vppaccounts/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/vppaccounts/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/vppaccounts/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/vppaccounts/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/vppaccounts/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /vppaccounts/id/{id}
Finds VPP Account by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<contact>string</contact>
<service_token>string</service_token>
<account_name>string</account_name>
<expiration_date>string</expiration_date>
<country>string</country>
<apple_id>string</apple_id>
<site>
<id>0</id>
<name>string</name>
</site>
<populate_catalog_from_vpp_content>true</populate_catalog_from_vpp_content>
<notify_disassociation>true</notify_disassociation>
<auto_register_managed_users>true</auto_register_managed_users>
updateVPPAdminAccountById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/vppaccounts/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/vppaccounts/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/vppaccounts/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/vppaccounts/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/vppaccounts/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/vppaccounts/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/vppaccounts/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /vppaccounts/id/{id}
Updates a VPP account by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createVPPAdminAccountById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/vppaccounts/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/vppaccounts/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/vppaccounts/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"contact": "string",
"service_token": "string",
"account_name": "string",
"expiration_date": "string",
"country": "string",
"apple_id": "string",
"site": {
"id": 0,
"name": "string"
},
"populate_catalog_from_vpp_content": true,
"notify_disassociation": true,
"auto_register_managed_users": true
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/vppaccounts/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/vppaccounts/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/vppaccounts/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/vppaccounts/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /vppaccounts/id/{id}
Creates a new VPP account by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | vpp_account | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<contact>string</contact>
<service_token>string</service_token>
<account_name>string</account_name>
<expiration_date>string</expiration_date>
<country>string</country>
<apple_id>string</apple_id>
<site>
<id>0</id>
<name>string</name>
</site>
<populate_catalog_from_vpp_content>true</populate_catalog_from_vpp_content>
<notify_disassociation>true</notify_disassociation>
<auto_register_managed_users>true</auto_register_managed_users>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteVPPAdminAccountById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/vppaccounts/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/vppaccounts/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/vppaccounts/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/vppaccounts/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/vppaccounts/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/vppaccounts/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/vppaccounts/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /vppaccounts/id/{id}
Deletes a VPP account by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findVPPAdminAssignment
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/vppassignments \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/vppassignments HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/vppassignments',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/vppassignments',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/vppassignments', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/vppassignments', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/vppassignments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /vppassignments
Finds all VPP Assignments
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<vpp_assignment>
<id>0</id>
<vpp_admin_account_id>0</vpp_admin_account_id>
<name>string</name>
</vpp_assignment>
findAssignmentById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/vppassignments/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/vppassignments/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/vppassignments/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/vppassignments/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/vppassignments/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/vppassignments/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/vppassignments/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /vppassignments/id/{id}
Finds VPP Assignment by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<vpp_admin_account_id>0</vpp_admin_account_id>
<vpp_admin_account_name>string</vpp_admin_account_name>
</general>
<ios_apps>
<ios_app>
<adam_id>0</adam_id>
<name>string</name>
</ios_app>
</ios_apps>
<ebooks>
<ebook>
<adam_id>0</adam_id>
<name>string</name>
</ebook>
</ebooks>
updateAssignmentById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/vppassignments/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/vppassignments/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/vppassignments/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/vppassignments/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/vppassignments/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/vppassignments/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/vppassignments/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /vppassignments/id/{id}
Updates a VPP assignment by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createAssignmentById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/vppassignments/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/vppassignments/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/vppassignments/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"id": 0,
"name": "string",
"vpp_admin_account_id": 0,
"vpp_admin_account_name": "string"
},
"ios_apps": {
"ios_app": {
"adam_id": 0,
"name": "string"
}
},
"ebooks": {
"ebook": {
"adam_id": 0,
"name": "string"
}
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/vppassignments/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/vppassignments/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/vppassignments/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/vppassignments/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /vppassignments/id/{id}
Creates a new VPP assignment by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | vpp_assignment | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<vpp_admin_account_id>0</vpp_admin_account_id>
<vpp_admin_account_name>string</vpp_admin_account_name>
</general>
<ios_apps>
<ios_app>
<adam_id>0</adam_id>
<name>string</name>
</ios_app>
</ios_apps>
<ebooks>
<ebook>
<adam_id>0</adam_id>
<name>string</name>
</ebook>
</ebooks>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteAssignmentById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/vppassignments/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/vppassignments/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/vppassignments/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/vppassignments/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/vppassignments/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/vppassignments/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/vppassignments/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /vppassignments/id/{id}
Deletes a VPP assignment by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findVPPAdminInvitation
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/vppinvitations \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/vppinvitations HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/vppinvitations',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/vppinvitations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/vppinvitations', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/vppinvitations', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/vppinvitations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /vppinvitations
Finds all VPP Invitations
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<vpp_invitation>
<id>0</id>
<name>string</name>
</vpp_invitation>
findInvitationById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/vppinvitations/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/vppinvitations/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/vppinvitations/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/vppinvitations/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/vppinvitations/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/vppinvitations/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/vppinvitations/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /vppinvitations/id/{id}
Finds a VPP Invitation by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<vpp_account>
<id>0</id>
</vpp_account>
<distribution_method>Prompt users to accept/make available in Self Service</distribution_method>
<sender_name>string</sender_name>
<sender_email_address>string</sender_email_address>
<subject>string</subject>
<message>string</message>
<invitation_usage>
<size>0</size>
</invitation_usage>
</general>
updateInvitationById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/vppinvitations/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/vppinvitations/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/vppinvitations/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/vppinvitations/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/vppinvitations/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/vppinvitations/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/vppinvitations/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /vppinvitations/id/{id}
Updates a VPP invitation by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createInvitationById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/vppinvitations/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/vppinvitations/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/vppinvitations/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"general": {
"id": 0,
"name": "string",
"vpp_account": {
"id": 0
},
"distribution_method": "Prompt users to accept/make available in Self Service",
"sender_name": "string",
"sender_email_address": "string",
"subject": "string",
"message": "string",
"invitation_usage": {
"size": 0
}
}
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/vppinvitations/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/vppinvitations/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/vppinvitations/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/vppinvitations/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /vppinvitations/id/{id}
Creates a new VPP invitation by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | vpp_invitation | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<general>
<id>0</id>
<name>string</name>
<vpp_account>
<id>0</id>
</vpp_account>
<distribution_method>Prompt users to accept/make available in Self Service</distribution_method>
<sender_name>string</sender_name>
<sender_email_address>string</sender_email_address>
<subject>string</subject>
<message>string</message>
<invitation_usage>
<size>0</size>
</invitation_usage>
</general>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteInvitationById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/vppinvitations/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/vppinvitations/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/vppinvitations/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/vppinvitations/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/vppinvitations/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/vppinvitations/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/vppinvitations/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /vppinvitations/id/{id}
Deletes a VPP invitation by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findInvitationsByIdSubset
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/vppinvitations/id/{id}/subset/{subset} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/vppinvitations/id/{id}/subset/{subset} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/vppinvitations/id/{id}/subset/{subset}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/vppinvitations/id/{id}/subset/{subset}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/vppinvitations/id/{id}/subset/{subset}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/vppinvitations/id/{id}/subset/{subset}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/vppinvitations/id/{id}/subset/{subset}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /vppinvitations/id/{id}/subset/{subset}
Display subsets of information for a VPP invitation
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID to filter by |
| subset | path | string | true | Subset to filter by |
Enumerated Values
| Parameter | Value |
|---|---|
| subset | General |
| subset | Scope |
| subset | InvitationUsages |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findWebhooks
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/webhooks \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/webhooks HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/webhooks',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/webhooks',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/webhooks', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/webhooks', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/webhooks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /webhooks
Finds all webhooks
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
findWebhooksById
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/webhooks/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/webhooks/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/webhooks/id/{id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/webhooks/id/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/webhooks/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/webhooks/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/webhooks/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /webhooks/id/{id}
Finds webhooks by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<enabled>true</enabled>
<url>string</url>
<content_type>text/xml</content_type>
<event>ComputerAdded</event>
updateWebhookById
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/webhooks/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/webhooks/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/webhooks/id/{id}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/webhooks/id/{id}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/webhooks/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/webhooks/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/webhooks/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /webhooks/id/{id}
Updates an existing webhook by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
createWebhookById
Code samples
# You can also use wget
curl -X post http://example.com/JSSResource/webhooks/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
POST http://example.com/JSSResource/webhooks/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/webhooks/id/{id}',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const inputBody = '{
"id": 0,
"name": "string",
"enabled": true,
"url": "string",
"content_type": "text/xml",
"event": "ComputerAdded"
}';
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/webhooks/id/{id}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.post 'http://example.com/JSSResource/webhooks/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.post('http://example.com/JSSResource/webhooks/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/webhooks/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /webhooks/id/{id}
Creates a new webhook by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
| body | body | webhook | true | No description |
Body parameter
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<enabled>true</enabled>
<url>string</url>
<content_type>text/xml</content_type>
<event>ComputerAdded</event>
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteWebhookById
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/webhooks/id/{id} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/webhooks/id/{id} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/webhooks/id/{id}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/webhooks/id/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/webhooks/id/{id}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/webhooks/id/{id}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/webhooks/id/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /webhooks/id/{id}
Deletes a webhook by ID
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | true | ID value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
findWebhooksByName
Code samples
# You can also use wget
curl -X get http://example.com/JSSResource/webhooks/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
GET http://example.com/JSSResource/webhooks/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/webhooks/name/{name}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/webhooks/name/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.get 'http://example.com/JSSResource/webhooks/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.get('http://example.com/JSSResource/webhooks/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/webhooks/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /webhooks/name/{name}
Finds webhooks by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |
Example responses
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<enabled>true</enabled>
<url>string</url>
<content_type>text/xml</content_type>
<event>ComputerAdded</event>
updateWebhookByName
Code samples
# You can also use wget
curl -X put http://example.com/JSSResource/webhooks/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
PUT http://example.com/JSSResource/webhooks/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/webhooks/name/{name}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/webhooks/name/{name}',
{
method: 'PUT',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.put 'http://example.com/JSSResource/webhooks/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.put('http://example.com/JSSResource/webhooks/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/webhooks/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
PUT /webhooks/name/{name}
Updates an existing webhook by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 201 | Created | Created |
deleteWebhookByName
Code samples
# You can also use wget
curl -X delete http://example.com/JSSResource/webhooks/name/{name} \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml'
DELETE http://example.com/JSSResource/webhooks/name/{name} HTTP/1.1
Host: example.com
Content-Type: application/xml
Accept: application/xml
var headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
$.ajax({
url: 'http://example.com/JSSResource/webhooks/name/{name}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const request = require('node-fetch');
const headers = {
'Content-Type':'application/xml',
'Accept':'application/xml'
};
fetch('http://example.com/JSSResource/webhooks/name/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/xml',
'Accept' => 'application/xml'
}
result = RestClient.delete 'http://example.com/JSSResource/webhooks/name/{name}', params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/xml',
'Accept': 'application/xml'
}
r = requests.delete('http://example.com/JSSResource/webhooks/name/{name}', params={
}, headers = headers)
print r.json()
URL obj = new URL("http://example.com/JSSResource/webhooks/name/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /webhooks/name/{name}
Deletes a webhook by name
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | Name value to filter by |
Responses
| Status | Meaning | Description |
|---|---|---|
| 200 | OK | OK |